diff --git a/docs/API_docs/methods/account_acceptAuthorization.md b/docs/API_docs/methods/account_acceptAuthorization.md index b92ec185..48cafe8a 100644 --- a/docs/API_docs/methods/account_acceptAuthorization.md +++ b/docs/API_docs/methods/account_acceptAuthorization.md @@ -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) diff --git a/docs/API_docs/methods/account_changePhone.md b/docs/API_docs/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/docs/API_docs/methods/account_changePhone.md +++ b/docs/API_docs/methods/account_changePhone.md @@ -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) diff --git a/docs/API_docs/methods/account_checkUsername.md b/docs/API_docs/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/docs/API_docs/methods/account_checkUsername.md +++ b/docs/API_docs/methods/account_checkUsername.md @@ -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) diff --git a/docs/API_docs/methods/account_confirmPhone.md b/docs/API_docs/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/docs/API_docs/methods/account_confirmPhone.md +++ b/docs/API_docs/methods/account_confirmPhone.md @@ -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) diff --git a/docs/API_docs/methods/account_deleteAccount.md b/docs/API_docs/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/docs/API_docs/methods/account_deleteAccount.md +++ b/docs/API_docs/methods/account_deleteAccount.md @@ -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) diff --git a/docs/API_docs/methods/account_deleteSecureValue.md b/docs/API_docs/methods/account_deleteSecureValue.md index b8e1c613..cfb5bdf1 100644 --- a/docs/API_docs/methods/account_deleteSecureValue.md +++ b/docs/API_docs/methods/account_deleteSecureValue.md @@ -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) diff --git a/docs/API_docs/methods/account_finishTakeoutSession.md b/docs/API_docs/methods/account_finishTakeoutSession.md index f858b3d8..6b21cbef 100644 --- a/docs/API_docs/methods/account_finishTakeoutSession.md +++ b/docs/API_docs/methods/account_finishTakeoutSession.md @@ -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) diff --git a/docs/API_docs/methods/account_getAuthorizationForm.md b/docs/API_docs/methods/account_getAuthorizationForm.md index e3353093..ae177a4a 100644 --- a/docs/API_docs/methods/account_getAuthorizationForm.md +++ b/docs/API_docs/methods/account_getAuthorizationForm.md @@ -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) diff --git a/docs/API_docs/methods/account_getNotifySettings.md b/docs/API_docs/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/docs/API_docs/methods/account_getNotifySettings.md +++ b/docs/API_docs/methods/account_getNotifySettings.md @@ -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) diff --git a/docs/API_docs/methods/account_getPasswordSettings.md b/docs/API_docs/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/docs/API_docs/methods/account_getPasswordSettings.md +++ b/docs/API_docs/methods/account_getPasswordSettings.md @@ -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) diff --git a/docs/API_docs/methods/account_getPrivacy.md b/docs/API_docs/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/docs/API_docs/methods/account_getPrivacy.md +++ b/docs/API_docs/methods/account_getPrivacy.md @@ -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) diff --git a/docs/API_docs/methods/account_getSecureValue.md b/docs/API_docs/methods/account_getSecureValue.md index 9aa09313..d62988b4 100644 --- a/docs/API_docs/methods/account_getSecureValue.md +++ b/docs/API_docs/methods/account_getSecureValue.md @@ -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) diff --git a/docs/API_docs/methods/account_getTmpPassword.md b/docs/API_docs/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/docs/API_docs/methods/account_getTmpPassword.md +++ b/docs/API_docs/methods/account_getTmpPassword.md @@ -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) diff --git a/docs/API_docs/methods/account_initTakeoutSession.md b/docs/API_docs/methods/account_initTakeoutSession.md index d11c9075..68fc8ab3 100644 --- a/docs/API_docs/methods/account_initTakeoutSession.md +++ b/docs/API_docs/methods/account_initTakeoutSession.md @@ -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) diff --git a/docs/API_docs/methods/account_registerDevice.md b/docs/API_docs/methods/account_registerDevice.md index 812f5e44..a1256cd1 100644 --- a/docs/API_docs/methods/account_registerDevice.md +++ b/docs/API_docs/methods/account_registerDevice.md @@ -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) diff --git a/docs/API_docs/methods/account_reportPeer.md b/docs/API_docs/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/docs/API_docs/methods/account_reportPeer.md +++ b/docs/API_docs/methods/account_reportPeer.md @@ -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) diff --git a/docs/API_docs/methods/account_resetAuthorization.md b/docs/API_docs/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/docs/API_docs/methods/account_resetAuthorization.md +++ b/docs/API_docs/methods/account_resetAuthorization.md @@ -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) diff --git a/docs/API_docs/methods/account_resetWebAuthorization.md b/docs/API_docs/methods/account_resetWebAuthorization.md index 9d42f177..2d987787 100644 --- a/docs/API_docs/methods/account_resetWebAuthorization.md +++ b/docs/API_docs/methods/account_resetWebAuthorization.md @@ -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) diff --git a/docs/API_docs/methods/account_saveSecureValue.md b/docs/API_docs/methods/account_saveSecureValue.md index beb39134..a54d1783 100644 --- a/docs/API_docs/methods/account_saveSecureValue.md +++ b/docs/API_docs/methods/account_saveSecureValue.md @@ -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) diff --git a/docs/API_docs/methods/account_sendChangePhoneCode.md b/docs/API_docs/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/docs/API_docs/methods/account_sendChangePhoneCode.md +++ b/docs/API_docs/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/docs/API_docs/methods/account_sendConfirmPhoneCode.md b/docs/API_docs/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/docs/API_docs/methods/account_sendConfirmPhoneCode.md +++ b/docs/API_docs/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/docs/API_docs/methods/account_sendVerifyEmailCode.md b/docs/API_docs/methods/account_sendVerifyEmailCode.md index c513c310..712018bd 100644 --- a/docs/API_docs/methods/account_sendVerifyEmailCode.md +++ b/docs/API_docs/methods/account_sendVerifyEmailCode.md @@ -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) diff --git a/docs/API_docs/methods/account_sendVerifyPhoneCode.md b/docs/API_docs/methods/account_sendVerifyPhoneCode.md index 4420d730..ea7e6c10 100644 --- a/docs/API_docs/methods/account_sendVerifyPhoneCode.md +++ b/docs/API_docs/methods/account_sendVerifyPhoneCode.md @@ -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) diff --git a/docs/API_docs/methods/account_setAccountTTL.md b/docs/API_docs/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/docs/API_docs/methods/account_setAccountTTL.md +++ b/docs/API_docs/methods/account_setAccountTTL.md @@ -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) diff --git a/docs/API_docs/methods/account_setPrivacy.md b/docs/API_docs/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/docs/API_docs/methods/account_setPrivacy.md +++ b/docs/API_docs/methods/account_setPrivacy.md @@ -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) diff --git a/docs/API_docs/methods/account_unregisterDevice.md b/docs/API_docs/methods/account_unregisterDevice.md index 5da8c776..b20ec9f0 100644 --- a/docs/API_docs/methods/account_unregisterDevice.md +++ b/docs/API_docs/methods/account_unregisterDevice.md @@ -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) diff --git a/docs/API_docs/methods/account_updateDeviceLocked.md b/docs/API_docs/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/docs/API_docs/methods/account_updateDeviceLocked.md +++ b/docs/API_docs/methods/account_updateDeviceLocked.md @@ -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) diff --git a/docs/API_docs/methods/account_updateNotifySettings.md b/docs/API_docs/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/docs/API_docs/methods/account_updateNotifySettings.md +++ b/docs/API_docs/methods/account_updateNotifySettings.md @@ -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) diff --git a/docs/API_docs/methods/account_updatePasswordSettings.md b/docs/API_docs/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/docs/API_docs/methods/account_updatePasswordSettings.md +++ b/docs/API_docs/methods/account_updatePasswordSettings.md @@ -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) diff --git a/docs/API_docs/methods/account_updateProfile.md b/docs/API_docs/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/docs/API_docs/methods/account_updateProfile.md +++ b/docs/API_docs/methods/account_updateProfile.md @@ -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) diff --git a/docs/API_docs/methods/account_updateStatus.md b/docs/API_docs/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/docs/API_docs/methods/account_updateStatus.md +++ b/docs/API_docs/methods/account_updateStatus.md @@ -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) diff --git a/docs/API_docs/methods/account_updateUsername.md b/docs/API_docs/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/docs/API_docs/methods/account_updateUsername.md +++ b/docs/API_docs/methods/account_updateUsername.md @@ -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) diff --git a/docs/API_docs/methods/account_verifyEmail.md b/docs/API_docs/methods/account_verifyEmail.md index ee14f51b..4cfc82aa 100644 --- a/docs/API_docs/methods/account_verifyEmail.md +++ b/docs/API_docs/methods/account_verifyEmail.md @@ -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) diff --git a/docs/API_docs/methods/account_verifyPhone.md b/docs/API_docs/methods/account_verifyPhone.md index 667416e7..075ab95b 100644 --- a/docs/API_docs/methods/account_verifyPhone.md +++ b/docs/API_docs/methods/account_verifyPhone.md @@ -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) diff --git a/docs/API_docs/methods/auth_cancelCode.md b/docs/API_docs/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/docs/API_docs/methods/auth_cancelCode.md +++ b/docs/API_docs/methods/auth_cancelCode.md @@ -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) diff --git a/docs/API_docs/methods/auth_dropTempAuthKeys.md b/docs/API_docs/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/docs/API_docs/methods/auth_dropTempAuthKeys.md +++ b/docs/API_docs/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/docs/API_docs/methods/auth_recoverPassword.md b/docs/API_docs/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/docs/API_docs/methods/auth_recoverPassword.md +++ b/docs/API_docs/methods/auth_recoverPassword.md @@ -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) diff --git a/docs/API_docs/methods/auth_resendCode.md b/docs/API_docs/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/docs/API_docs/methods/auth_resendCode.md +++ b/docs/API_docs/methods/auth_resendCode.md @@ -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) diff --git a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/docs/API_docs/methods/bots_answerWebhookJSONQuery.md +++ b/docs/API_docs/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/docs/API_docs/methods/bots_sendCustomRequest.md b/docs/API_docs/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/docs/API_docs/methods/bots_sendCustomRequest.md +++ b/docs/API_docs/methods/bots_sendCustomRequest.md @@ -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) diff --git a/docs/API_docs/methods/channels_checkUsername.md b/docs/API_docs/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/docs/API_docs/methods/channels_checkUsername.md +++ b/docs/API_docs/methods/channels_checkUsername.md @@ -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) diff --git a/docs/API_docs/methods/channels_createChannel.md b/docs/API_docs/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/docs/API_docs/methods/channels_createChannel.md +++ b/docs/API_docs/methods/channels_createChannel.md @@ -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) diff --git a/docs/API_docs/methods/channels_deleteChannel.md b/docs/API_docs/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/docs/API_docs/methods/channels_deleteChannel.md +++ b/docs/API_docs/methods/channels_deleteChannel.md @@ -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) diff --git a/docs/API_docs/methods/channels_deleteHistory.md b/docs/API_docs/methods/channels_deleteHistory.md index d33bdbe0..ea331b8b 100644 --- a/docs/API_docs/methods/channels_deleteHistory.md +++ b/docs/API_docs/methods/channels_deleteHistory.md @@ -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) diff --git a/docs/API_docs/methods/channels_deleteMessages.md b/docs/API_docs/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/docs/API_docs/methods/channels_deleteMessages.md +++ b/docs/API_docs/methods/channels_deleteMessages.md @@ -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) diff --git a/docs/API_docs/methods/channels_deleteUserHistory.md b/docs/API_docs/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/docs/API_docs/methods/channels_deleteUserHistory.md +++ b/docs/API_docs/methods/channels_deleteUserHistory.md @@ -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) diff --git a/docs/API_docs/methods/channels_editAbout.md b/docs/API_docs/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/docs/API_docs/methods/channels_editAbout.md +++ b/docs/API_docs/methods/channels_editAbout.md @@ -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) diff --git a/docs/API_docs/methods/channels_editAdmin.md b/docs/API_docs/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/docs/API_docs/methods/channels_editAdmin.md +++ b/docs/API_docs/methods/channels_editAdmin.md @@ -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) diff --git a/docs/API_docs/methods/channels_editBanned.md b/docs/API_docs/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/docs/API_docs/methods/channels_editBanned.md +++ b/docs/API_docs/methods/channels_editBanned.md @@ -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) diff --git a/docs/API_docs/methods/channels_editPhoto.md b/docs/API_docs/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/docs/API_docs/methods/channels_editPhoto.md +++ b/docs/API_docs/methods/channels_editPhoto.md @@ -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) diff --git a/docs/API_docs/methods/channels_editTitle.md b/docs/API_docs/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/docs/API_docs/methods/channels_editTitle.md +++ b/docs/API_docs/methods/channels_editTitle.md @@ -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) diff --git a/docs/API_docs/methods/channels_exportInvite.md b/docs/API_docs/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/docs/API_docs/methods/channels_exportInvite.md +++ b/docs/API_docs/methods/channels_exportInvite.md @@ -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) diff --git a/docs/API_docs/methods/channels_exportMessageLink.md b/docs/API_docs/methods/channels_exportMessageLink.md index 595e4b70..3b6e7e9e 100644 --- a/docs/API_docs/methods/channels_exportMessageLink.md +++ b/docs/API_docs/methods/channels_exportMessageLink.md @@ -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) diff --git a/docs/API_docs/methods/channels_getAdminLog.md b/docs/API_docs/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/docs/API_docs/methods/channels_getAdminLog.md +++ b/docs/API_docs/methods/channels_getAdminLog.md @@ -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) diff --git a/docs/API_docs/methods/channels_getChannels.md b/docs/API_docs/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/docs/API_docs/methods/channels_getChannels.md +++ b/docs/API_docs/methods/channels_getChannels.md @@ -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) diff --git a/docs/API_docs/methods/channels_getLeftChannels.md b/docs/API_docs/methods/channels_getLeftChannels.md index b51c86d9..cf06518b 100644 --- a/docs/API_docs/methods/channels_getLeftChannels.md +++ b/docs/API_docs/methods/channels_getLeftChannels.md @@ -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) diff --git a/docs/API_docs/methods/channels_getMessages.md b/docs/API_docs/methods/channels_getMessages.md index 2c2d822a..4f63c3a2 100644 --- a/docs/API_docs/methods/channels_getMessages.md +++ b/docs/API_docs/methods/channels_getMessages.md @@ -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) diff --git a/docs/API_docs/methods/channels_getParticipant.md b/docs/API_docs/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/docs/API_docs/methods/channels_getParticipant.md +++ b/docs/API_docs/methods/channels_getParticipant.md @@ -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) diff --git a/docs/API_docs/methods/channels_getParticipants.md b/docs/API_docs/methods/channels_getParticipants.md index 00446bf1..0ab83257 100644 --- a/docs/API_docs/methods/channels_getParticipants.md +++ b/docs/API_docs/methods/channels_getParticipants.md @@ -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) diff --git a/docs/API_docs/methods/channels_inviteToChannel.md b/docs/API_docs/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/docs/API_docs/methods/channels_inviteToChannel.md +++ b/docs/API_docs/methods/channels_inviteToChannel.md @@ -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) diff --git a/docs/API_docs/methods/channels_joinChannel.md b/docs/API_docs/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/docs/API_docs/methods/channels_joinChannel.md +++ b/docs/API_docs/methods/channels_joinChannel.md @@ -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) diff --git a/docs/API_docs/methods/channels_leaveChannel.md b/docs/API_docs/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/docs/API_docs/methods/channels_leaveChannel.md +++ b/docs/API_docs/methods/channels_leaveChannel.md @@ -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) diff --git a/docs/API_docs/methods/channels_readHistory.md b/docs/API_docs/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/docs/API_docs/methods/channels_readHistory.md +++ b/docs/API_docs/methods/channels_readHistory.md @@ -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) diff --git a/docs/API_docs/methods/channels_readMessageContents.md b/docs/API_docs/methods/channels_readMessageContents.md index f0addc30..51fffda5 100644 --- a/docs/API_docs/methods/channels_readMessageContents.md +++ b/docs/API_docs/methods/channels_readMessageContents.md @@ -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) diff --git a/docs/API_docs/methods/channels_reportSpam.md b/docs/API_docs/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/docs/API_docs/methods/channels_reportSpam.md +++ b/docs/API_docs/methods/channels_reportSpam.md @@ -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) diff --git a/docs/API_docs/methods/channels_setStickers.md b/docs/API_docs/methods/channels_setStickers.md index 8557a723..421b3ec1 100644 --- a/docs/API_docs/methods/channels_setStickers.md +++ b/docs/API_docs/methods/channels_setStickers.md @@ -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) diff --git a/docs/API_docs/methods/channels_toggleInvites.md b/docs/API_docs/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/docs/API_docs/methods/channels_toggleInvites.md +++ b/docs/API_docs/methods/channels_toggleInvites.md @@ -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) diff --git a/docs/API_docs/methods/channels_togglePreHistoryHidden.md b/docs/API_docs/methods/channels_togglePreHistoryHidden.md index cc48c100..c25f6358 100644 --- a/docs/API_docs/methods/channels_togglePreHistoryHidden.md +++ b/docs/API_docs/methods/channels_togglePreHistoryHidden.md @@ -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) diff --git a/docs/API_docs/methods/channels_toggleSignatures.md b/docs/API_docs/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/docs/API_docs/methods/channels_toggleSignatures.md +++ b/docs/API_docs/methods/channels_toggleSignatures.md @@ -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) diff --git a/docs/API_docs/methods/channels_updatePinnedMessage.md b/docs/API_docs/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/docs/API_docs/methods/channels_updatePinnedMessage.md +++ b/docs/API_docs/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/docs/API_docs/methods/channels_updateUsername.md b/docs/API_docs/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/docs/API_docs/methods/channels_updateUsername.md +++ b/docs/API_docs/methods/channels_updateUsername.md @@ -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) diff --git a/docs/API_docs/methods/contacts_block.md b/docs/API_docs/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/docs/API_docs/methods/contacts_block.md +++ b/docs/API_docs/methods/contacts_block.md @@ -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) diff --git a/docs/API_docs/methods/contacts_deleteContact.md b/docs/API_docs/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/docs/API_docs/methods/contacts_deleteContact.md +++ b/docs/API_docs/methods/contacts_deleteContact.md @@ -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) diff --git a/docs/API_docs/methods/contacts_deleteContacts.md b/docs/API_docs/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/docs/API_docs/methods/contacts_deleteContacts.md +++ b/docs/API_docs/methods/contacts_deleteContacts.md @@ -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) diff --git a/docs/API_docs/methods/contacts_getBlocked.md b/docs/API_docs/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/docs/API_docs/methods/contacts_getBlocked.md +++ b/docs/API_docs/methods/contacts_getBlocked.md @@ -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) diff --git a/docs/API_docs/methods/contacts_getContacts.md b/docs/API_docs/methods/contacts_getContacts.md index 58c49847..48634fbb 100644 --- a/docs/API_docs/methods/contacts_getContacts.md +++ b/docs/API_docs/methods/contacts_getContacts.md @@ -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) diff --git a/docs/API_docs/methods/contacts_getTopPeers.md b/docs/API_docs/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/docs/API_docs/methods/contacts_getTopPeers.md +++ b/docs/API_docs/methods/contacts_getTopPeers.md @@ -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) diff --git a/docs/API_docs/methods/contacts_importCard.md b/docs/API_docs/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/docs/API_docs/methods/contacts_importCard.md +++ b/docs/API_docs/methods/contacts_importCard.md @@ -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) diff --git a/docs/API_docs/methods/contacts_importContacts.md b/docs/API_docs/methods/contacts_importContacts.md index 6aee0ac0..eddbe116 100644 --- a/docs/API_docs/methods/contacts_importContacts.md +++ b/docs/API_docs/methods/contacts_importContacts.md @@ -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) diff --git a/docs/API_docs/methods/contacts_resetTopPeerRating.md b/docs/API_docs/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/docs/API_docs/methods/contacts_resetTopPeerRating.md +++ b/docs/API_docs/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/docs/API_docs/methods/contacts_search.md b/docs/API_docs/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/docs/API_docs/methods/contacts_search.md +++ b/docs/API_docs/methods/contacts_search.md @@ -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) diff --git a/docs/API_docs/methods/contacts_toggleTopPeers.md b/docs/API_docs/methods/contacts_toggleTopPeers.md index 32cf5691..ef7502a3 100644 --- a/docs/API_docs/methods/contacts_toggleTopPeers.md +++ b/docs/API_docs/methods/contacts_toggleTopPeers.md @@ -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) diff --git a/docs/API_docs/methods/contacts_unblock.md b/docs/API_docs/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/docs/API_docs/methods/contacts_unblock.md +++ b/docs/API_docs/methods/contacts_unblock.md @@ -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) diff --git a/docs/API_docs/methods/help_acceptTermsOfService.md b/docs/API_docs/methods/help_acceptTermsOfService.md index 54f78d58..9d9a5f89 100644 --- a/docs/API_docs/methods/help_acceptTermsOfService.md +++ b/docs/API_docs/methods/help_acceptTermsOfService.md @@ -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) diff --git a/docs/API_docs/methods/help_getAppChangelog.md b/docs/API_docs/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/docs/API_docs/methods/help_getAppChangelog.md +++ b/docs/API_docs/methods/help_getAppChangelog.md @@ -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) diff --git a/docs/API_docs/methods/help_getDeepLinkInfo.md b/docs/API_docs/methods/help_getDeepLinkInfo.md index 3bba16de..9e816258 100644 --- a/docs/API_docs/methods/help_getDeepLinkInfo.md +++ b/docs/API_docs/methods/help_getDeepLinkInfo.md @@ -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) diff --git a/docs/API_docs/methods/help_getRecentMeUrls.md b/docs/API_docs/methods/help_getRecentMeUrls.md index 5043cc42..27a451bb 100644 --- a/docs/API_docs/methods/help_getRecentMeUrls.md +++ b/docs/API_docs/methods/help_getRecentMeUrls.md @@ -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) diff --git a/docs/API_docs/methods/help_saveAppLog.md b/docs/API_docs/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/docs/API_docs/methods/help_saveAppLog.md +++ b/docs/API_docs/methods/help_saveAppLog.md @@ -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) diff --git a/docs/API_docs/methods/help_setBotUpdatesStatus.md b/docs/API_docs/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/docs/API_docs/methods/help_setBotUpdatesStatus.md +++ b/docs/API_docs/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/docs/API_docs/methods/initConnection.md b/docs/API_docs/methods/initConnection.md index eb1b522e..71d71bb8 100644 --- a/docs/API_docs/methods/initConnection.md +++ b/docs/API_docs/methods/initConnection.md @@ -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) diff --git a/docs/API_docs/methods/invokeAfterMsg.md b/docs/API_docs/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/docs/API_docs/methods/invokeAfterMsg.md +++ b/docs/API_docs/methods/invokeAfterMsg.md @@ -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) diff --git a/docs/API_docs/methods/invokeAfterMsgs.md b/docs/API_docs/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/docs/API_docs/methods/invokeAfterMsgs.md +++ b/docs/API_docs/methods/invokeAfterMsgs.md @@ -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) diff --git a/docs/API_docs/methods/invokeWithLayer.md b/docs/API_docs/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/docs/API_docs/methods/invokeWithLayer.md +++ b/docs/API_docs/methods/invokeWithLayer.md @@ -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) diff --git a/docs/API_docs/methods/invokeWithMessagesRange.md b/docs/API_docs/methods/invokeWithMessagesRange.md index cdf2dae3..24e87100 100644 --- a/docs/API_docs/methods/invokeWithMessagesRange.md +++ b/docs/API_docs/methods/invokeWithMessagesRange.md @@ -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) diff --git a/docs/API_docs/methods/invokeWithTakeout.md b/docs/API_docs/methods/invokeWithTakeout.md index a51e1690..aa6683a4 100644 --- a/docs/API_docs/methods/invokeWithTakeout.md +++ b/docs/API_docs/methods/invokeWithTakeout.md @@ -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) diff --git a/docs/API_docs/methods/invokeWithoutUpdates.md b/docs/API_docs/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/docs/API_docs/methods/invokeWithoutUpdates.md +++ b/docs/API_docs/methods/invokeWithoutUpdates.md @@ -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) diff --git a/docs/API_docs/methods/langpack_getDifference.md b/docs/API_docs/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/docs/API_docs/methods/langpack_getDifference.md +++ b/docs/API_docs/methods/langpack_getDifference.md @@ -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) diff --git a/docs/API_docs/methods/langpack_getLangPack.md b/docs/API_docs/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/docs/API_docs/methods/langpack_getLangPack.md +++ b/docs/API_docs/methods/langpack_getLangPack.md @@ -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) diff --git a/docs/API_docs/methods/langpack_getStrings.md b/docs/API_docs/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/docs/API_docs/methods/langpack_getStrings.md +++ b/docs/API_docs/methods/langpack_getStrings.md @@ -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) diff --git a/docs/API_docs/methods/messages_addChatUser.md b/docs/API_docs/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/docs/API_docs/methods/messages_addChatUser.md +++ b/docs/API_docs/methods/messages_addChatUser.md @@ -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) diff --git a/docs/API_docs/methods/messages_checkChatInvite.md b/docs/API_docs/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/docs/API_docs/methods/messages_checkChatInvite.md +++ b/docs/API_docs/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/docs/API_docs/methods/messages_clearRecentStickers.md b/docs/API_docs/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/docs/API_docs/methods/messages_clearRecentStickers.md +++ b/docs/API_docs/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_createChat.md b/docs/API_docs/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/docs/API_docs/methods/messages_createChat.md +++ b/docs/API_docs/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_deleteChatUser.md b/docs/API_docs/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/docs/API_docs/methods/messages_deleteChatUser.md +++ b/docs/API_docs/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_deleteHistory.md b/docs/API_docs/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/docs/API_docs/methods/messages_deleteHistory.md +++ b/docs/API_docs/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/docs/API_docs/methods/messages_deleteMessages.md b/docs/API_docs/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/docs/API_docs/methods/messages_deleteMessages.md +++ b/docs/API_docs/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/docs/API_docs/methods/messages_editChatAdmin.md b/docs/API_docs/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/docs/API_docs/methods/messages_editChatAdmin.md +++ b/docs/API_docs/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_editChatPhoto.md b/docs/API_docs/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/docs/API_docs/methods/messages_editChatPhoto.md +++ b/docs/API_docs/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_editChatTitle.md b/docs/API_docs/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/docs/API_docs/methods/messages_editChatTitle.md +++ b/docs/API_docs/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_editInlineBotMessage.md b/docs/API_docs/methods/messages_editInlineBotMessage.md index 4d097f4c..ec4620f4 100644 --- a/docs/API_docs/methods/messages_editInlineBotMessage.md +++ b/docs/API_docs/methods/messages_editInlineBotMessage.md @@ -11,17 +11,17 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to substitute| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to substitute | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_editMessage.md b/docs/API_docs/methods/messages_editMessage.md index f5a5b5c1..4bceb2aa 100644 --- a/docs/API_docs/methods/messages_editMessage.md +++ b/docs/API_docs/methods/messages_editMessage.md @@ -11,18 +11,18 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to substitute| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to substitute | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_exportChatInvite.md b/docs/API_docs/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/docs/API_docs/methods/messages_exportChatInvite.md +++ b/docs/API_docs/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/docs/API_docs/methods/messages_faveSticker.md b/docs/API_docs/methods/messages_faveSticker.md index 05c04983..302957c5 100644 --- a/docs/API_docs/methods/messages_faveSticker.md +++ b/docs/API_docs/methods/messages_faveSticker.md @@ -11,10 +11,10 @@ Add a sticker to favorites ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional| +|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_forwardMessages.md b/docs/API_docs/methods/messages_forwardMessages.md index e0091c2e..3372333c 100644 --- a/docs/API_docs/methods/messages_forwardMessages.md +++ b/docs/API_docs/methods/messages_forwardMessages.md @@ -11,15 +11,15 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|grouped|[Bool](../types/Bool.md) | Set to true if forwarding albums | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_getAllChats.md b/docs/API_docs/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/docs/API_docs/methods/messages_getAllChats.md +++ b/docs/API_docs/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/messages_getAllStickers.md b/docs/API_docs/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/docs/API_docs/methods/messages_getAllStickers.md +++ b/docs/API_docs/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/docs/API_docs/methods/messages_getArchivedStickers.md b/docs/API_docs/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/docs/API_docs/methods/messages_getArchivedStickers.md +++ b/docs/API_docs/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/docs/API_docs/methods/messages_getAttachedStickers.md b/docs/API_docs/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/docs/API_docs/methods/messages_getAttachedStickers.md +++ b/docs/API_docs/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/docs/API_docs/methods/messages_getBotCallbackAnswer.md b/docs/API_docs/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/docs/API_docs/methods/messages_getBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/docs/API_docs/methods/messages_getChats.md b/docs/API_docs/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/docs/API_docs/methods/messages_getChats.md +++ b/docs/API_docs/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/messages_getCommonChats.md b/docs/API_docs/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/docs/API_docs/methods/messages_getCommonChats.md +++ b/docs/API_docs/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/docs/API_docs/methods/messages_getDialogs.md b/docs/API_docs/methods/messages_getDialogs.md index 1341a117..03b6be6e 100644 --- a/docs/API_docs/methods/messages_getDialogs.md +++ b/docs/API_docs/methods/messages_getDialogs.md @@ -11,14 +11,14 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched dialogs or [])| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched dialogs or []) | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/docs/API_docs/methods/messages_getDocumentByHash.md b/docs/API_docs/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/docs/API_docs/methods/messages_getDocumentByHash.md +++ b/docs/API_docs/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/docs/API_docs/methods/messages_getFavedStickers.md b/docs/API_docs/methods/messages_getFavedStickers.md index cae141f4..4ea69f9f 100644 --- a/docs/API_docs/methods/messages_getFavedStickers.md +++ b/docs/API_docs/methods/messages_getFavedStickers.md @@ -11,9 +11,9 @@ Get favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/docs/API_docs/methods/messages_getFeaturedStickers.md b/docs/API_docs/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/docs/API_docs/methods/messages_getFeaturedStickers.md +++ b/docs/API_docs/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/docs/API_docs/methods/messages_getGameHighScores.md b/docs/API_docs/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/docs/API_docs/methods/messages_getGameHighScores.md +++ b/docs/API_docs/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/docs/API_docs/methods/messages_getHistory.md b/docs/API_docs/methods/messages_getHistory.md index 0d6eee5a..7864e4ad 100644 --- a/docs/API_docs/methods/messages_getHistory.md +++ b/docs/API_docs/methods/messages_getHistory.md @@ -11,16 +11,16 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| -|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| +|hash|[int](../types/int.md) | hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getInlineBotResults.md b/docs/API_docs/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/docs/API_docs/methods/messages_getInlineBotResults.md +++ b/docs/API_docs/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/docs/API_docs/methods/messages_getInlineGameHighScores.md b/docs/API_docs/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/docs/API_docs/methods/messages_getInlineGameHighScores.md +++ b/docs/API_docs/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/docs/API_docs/methods/messages_getMaskStickers.md b/docs/API_docs/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/docs/API_docs/methods/messages_getMaskStickers.md +++ b/docs/API_docs/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/docs/API_docs/methods/messages_getMessageEditData.md b/docs/API_docs/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/docs/API_docs/methods/messages_getMessageEditData.md +++ b/docs/API_docs/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/docs/API_docs/methods/messages_getMessages.md b/docs/API_docs/methods/messages_getMessages.md index c70d48c5..3cd40799 100644 --- a/docs/API_docs/methods/messages_getMessages.md +++ b/docs/API_docs/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getMessagesViews.md b/docs/API_docs/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/docs/API_docs/methods/messages_getMessagesViews.md +++ b/docs/API_docs/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/docs/API_docs/methods/messages_getPeerDialogs.md b/docs/API_docs/methods/messages_getPeerDialogs.md index 61dac347..5c41b5fb 100644 --- a/docs/API_docs/methods/messages_getPeerDialogs.md +++ b/docs/API_docs/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [InputDialogPeer](../types/InputDialogPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [InputDialogPeer](../types/InputDialogPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/docs/API_docs/methods/messages_getPeerSettings.md b/docs/API_docs/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/docs/API_docs/methods/messages_getPeerSettings.md +++ b/docs/API_docs/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/docs/API_docs/methods/messages_getRecentLocations.md b/docs/API_docs/methods/messages_getRecentLocations.md index d839c63c..b3427171 100644 --- a/docs/API_docs/methods/messages_getRecentLocations.md +++ b/docs/API_docs/methods/messages_getRecentLocations.md @@ -11,11 +11,11 @@ Get recent locations ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched locations, or []);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to search locations | Optional| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched locations, or []); | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getRecentStickers.md b/docs/API_docs/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/docs/API_docs/methods/messages_getRecentStickers.md +++ b/docs/API_docs/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/docs/API_docs/methods/messages_getSavedGifs.md b/docs/API_docs/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/docs/API_docs/methods/messages_getSavedGifs.md +++ b/docs/API_docs/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/docs/API_docs/methods/messages_getStickerSet.md b/docs/API_docs/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/docs/API_docs/methods/messages_getStickerSet.md +++ b/docs/API_docs/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/messages_getStickers.md b/docs/API_docs/methods/messages_getStickers.md index 7d2822d0..22c3c9ba 100644 --- a/docs/API_docs/methods/messages_getStickers.md +++ b/docs/API_docs/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched stickers, or []);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched stickers, or []); | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/docs/API_docs/methods/messages_getUnreadMentions.md b/docs/API_docs/methods/messages_getUnreadMentions.md index 88e895e4..9b221db9 100644 --- a/docs/API_docs/methods/messages_getUnreadMentions.md +++ b/docs/API_docs/methods/messages_getUnreadMentions.md @@ -11,14 +11,14 @@ Get unread mentions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[int](../types/int.md) | Yes|The offset| -|add\_offset|[int](../types/int.md) | Yes|The additional offset| -|limit|[int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to get unread mentions | Optional| +|offset\_id|[int](../types/int.md) | The offset | Yes| +|add\_offset|[int](../types/int.md) | The additional offset | Yes| +|limit|[int](../types/int.md) | The number of results to fetch | Yes| +|max\_id|[int](../types/int.md) | The maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | The minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_getWebPage.md b/docs/API_docs/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/docs/API_docs/methods/messages_getWebPage.md +++ b/docs/API_docs/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/docs/API_docs/methods/messages_getWebPagePreview.md b/docs/API_docs/methods/messages_getWebPagePreview.md index 21652a7b..99ef2e5a 100644 --- a/docs/API_docs/methods/messages_getWebPagePreview.md +++ b/docs/API_docs/methods/messages_getWebPagePreview.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/docs/API_docs/methods/messages_hideReportSpam.md b/docs/API_docs/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/docs/API_docs/methods/messages_hideReportSpam.md +++ b/docs/API_docs/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_importChatInvite.md b/docs/API_docs/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/docs/API_docs/methods/messages_importChatInvite.md +++ b/docs/API_docs/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_installStickerSet.md b/docs/API_docs/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/docs/API_docs/methods/messages_installStickerSet.md +++ b/docs/API_docs/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/docs/API_docs/methods/messages_markDialogUnread.md b/docs/API_docs/methods/messages_markDialogUnread.md index 5c22aefd..732ebac6 100644 --- a/docs/API_docs/methods/messages_markDialogUnread.md +++ b/docs/API_docs/methods/messages_markDialogUnread.md @@ -11,10 +11,10 @@ Mark dialog as unread ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|unread|[Bool](../types/Bool.md) | Optional|Should it be marked or unmarked as read| -|peer|[InputDialogPeer](../types/InputDialogPeer.md) | Yes|The dialog to mark as unread| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|unread|[Bool](../types/Bool.md) | Should it be marked or unmarked as read | Optional| +|peer|[InputDialogPeer](../types/InputDialogPeer.md) | The dialog to mark as unread | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_migrateChat.md b/docs/API_docs/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/docs/API_docs/methods/messages_migrateChat.md +++ b/docs/API_docs/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_readEncryptedHistory.md b/docs/API_docs/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/docs/API_docs/methods/messages_readEncryptedHistory.md +++ b/docs/API_docs/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_readFeaturedStickers.md b/docs/API_docs/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/docs/API_docs/methods/messages_readFeaturedStickers.md +++ b/docs/API_docs/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_readHistory.md b/docs/API_docs/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/docs/API_docs/methods/messages_readHistory.md +++ b/docs/API_docs/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/docs/API_docs/methods/messages_readMentions.md b/docs/API_docs/methods/messages_readMentions.md index c58cb06a..31874ee6 100644 --- a/docs/API_docs/methods/messages_readMentions.md +++ b/docs/API_docs/methods/messages_readMentions.md @@ -11,9 +11,9 @@ Mark mentions as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/docs/API_docs/methods/messages_readMessageContents.md b/docs/API_docs/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/docs/API_docs/methods/messages_readMessageContents.md +++ b/docs/API_docs/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/docs/API_docs/methods/messages_receivedMessages.md b/docs/API_docs/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/docs/API_docs/methods/messages_receivedMessages.md +++ b/docs/API_docs/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/docs/API_docs/methods/messages_reorderPinnedDialogs.md b/docs/API_docs/methods/messages_reorderPinnedDialogs.md index d6a517d2..8f5b821d 100644 --- a/docs/API_docs/methods/messages_reorderPinnedDialogs.md +++ b/docs/API_docs/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [InputDialogPeer](../types/InputDialogPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [InputDialogPeer](../types/InputDialogPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_reorderStickerSets.md b/docs/API_docs/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/docs/API_docs/methods/messages_reorderStickerSets.md +++ b/docs/API_docs/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_report.md b/docs/API_docs/methods/messages_report.md index f10246ed..8c940d7f 100644 --- a/docs/API_docs/methods/messages_report.md +++ b/docs/API_docs/methods/messages_report.md @@ -11,11 +11,11 @@ Report a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The user that sent the messages| -|id|Array of [int](../types/int.md) | Yes|The messages to report| -|reason|[ReportReason](../types/ReportReason.md) | Yes|The reason why you're sending this report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The user that sent the messages | Optional| +|id|Array of [int](../types/int.md) | The messages to report | Yes| +|reason|[ReportReason](../types/ReportReason.md) | The reason why you're sending this report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_reportEncryptedSpam.md b/docs/API_docs/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/docs/API_docs/methods/messages_reportEncryptedSpam.md +++ b/docs/API_docs/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_reportSpam.md b/docs/API_docs/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/docs/API_docs/methods/messages_reportSpam.md +++ b/docs/API_docs/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_saveDraft.md b/docs/API_docs/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/docs/API_docs/methods/messages_saveDraft.md +++ b/docs/API_docs/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/docs/API_docs/methods/messages_saveGif.md b/docs/API_docs/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/docs/API_docs/methods/messages_saveGif.md +++ b/docs/API_docs/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_saveRecentSticker.md b/docs/API_docs/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/docs/API_docs/methods/messages_saveRecentSticker.md +++ b/docs/API_docs/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_search.md b/docs/API_docs/methods/messages_search.md index e20ba0a3..f778a9d5 100644 --- a/docs/API_docs/methods/messages_search.md +++ b/docs/API_docs/methods/messages_search.md @@ -11,20 +11,20 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched messages);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|min\_id|[int](../types/int.md) | Minumum message id to return | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched messages); | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_searchGifs.md b/docs/API_docs/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/docs/API_docs/methods/messages_searchGifs.md +++ b/docs/API_docs/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/docs/API_docs/methods/messages_searchGlobal.md b/docs/API_docs/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/docs/API_docs/methods/messages_searchGlobal.md +++ b/docs/API_docs/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/docs/API_docs/methods/messages_searchStickerSets.md b/docs/API_docs/methods/messages_searchStickerSets.md index aeae2eea..4c386aea 100644 --- a/docs/API_docs/methods/messages_searchStickerSets.md +++ b/docs/API_docs/methods/messages_searchStickerSets.md @@ -11,11 +11,11 @@ Find a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_featured|[Bool](../types/Bool.md) | Optional|Exclude featured sticker sets from the search?| -|q|[string](../types/string.md) | Yes|The search query| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously searched stickers, or []);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_featured|[Bool](../types/Bool.md) | Exclude featured sticker sets from the search? | Optional| +|q|[string](../types/string.md) | The search query | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously searched stickers, or []); | Yes| ### Return type: [messages\_FoundStickerSets](../types/messages_FoundStickerSets.md) diff --git a/docs/API_docs/methods/messages_sendEncrypted.md b/docs/API_docs/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/docs/API_docs/methods/messages_sendEncrypted.md +++ b/docs/API_docs/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/docs/API_docs/methods/messages_sendEncryptedFile.md b/docs/API_docs/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/docs/API_docs/methods/messages_sendEncryptedFile.md +++ b/docs/API_docs/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/docs/API_docs/methods/messages_sendEncryptedService.md b/docs/API_docs/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/docs/API_docs/methods/messages_sendEncryptedService.md +++ b/docs/API_docs/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/docs/API_docs/methods/messages_sendInlineBotResult.md b/docs/API_docs/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/docs/API_docs/methods/messages_sendInlineBotResult.md +++ b/docs/API_docs/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_sendMedia.md b/docs/API_docs/methods/messages_sendMedia.md index a795c5d1..738c6df9 100644 --- a/docs/API_docs/methods/messages_sendMedia.md +++ b/docs/API_docs/methods/messages_sendMedia.md @@ -11,17 +11,17 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|message|[string](../types/string.md) | Yes|The caption| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|message|[string](../types/string.md) | The caption | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -127,6 +127,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http: |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/docs/API_docs/methods/messages_sendMessage.md b/docs/API_docs/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/docs/API_docs/methods/messages_sendMessage.md +++ b/docs/API_docs/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/docs/API_docs/methods/messages_sendMultiMedia.md b/docs/API_docs/methods/messages_sendMultiMedia.md index 92baa8ab..115d2f60 100644 --- a/docs/API_docs/methods/messages_sendMultiMedia.md +++ b/docs/API_docs/methods/messages_sendMultiMedia.md @@ -11,14 +11,14 @@ Send an album ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notification? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the album | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | The album | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_sendScreenshotNotification.md b/docs/API_docs/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/docs/API_docs/methods/messages_sendScreenshotNotification.md +++ b/docs/API_docs/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_setBotCallbackAnswer.md b/docs/API_docs/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/docs/API_docs/methods/messages_setBotCallbackAnswer.md +++ b/docs/API_docs/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/docs/API_docs/methods/messages_setBotPrecheckoutResults.md +++ b/docs/API_docs/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setBotShippingResults.md b/docs/API_docs/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/docs/API_docs/methods/messages_setBotShippingResults.md +++ b/docs/API_docs/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setEncryptedTyping.md b/docs/API_docs/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/docs/API_docs/methods/messages_setEncryptedTyping.md +++ b/docs/API_docs/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setGameScore.md b/docs/API_docs/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/docs/API_docs/methods/messages_setGameScore.md +++ b/docs/API_docs/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_setInlineBotResults.md b/docs/API_docs/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/docs/API_docs/methods/messages_setInlineBotResults.md +++ b/docs/API_docs/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setInlineGameScore.md b/docs/API_docs/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/docs/API_docs/methods/messages_setInlineGameScore.md +++ b/docs/API_docs/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_setTyping.md b/docs/API_docs/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/docs/API_docs/methods/messages_setTyping.md +++ b/docs/API_docs/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_startBot.md b/docs/API_docs/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/docs/API_docs/methods/messages_startBot.md +++ b/docs/API_docs/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_toggleChatAdmins.md b/docs/API_docs/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/docs/API_docs/methods/messages_toggleChatAdmins.md +++ b/docs/API_docs/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/messages_toggleDialogPin.md b/docs/API_docs/methods/messages_toggleDialogPin.md index 45c628d9..ee17a462 100644 --- a/docs/API_docs/methods/messages_toggleDialogPin.md +++ b/docs/API_docs/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[InputDialogPeer](../types/InputDialogPeer.md) | Yes|The dialog to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[InputDialogPeer](../types/InputDialogPeer.md) | The dialog to pin | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_uninstallStickerSet.md b/docs/API_docs/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/docs/API_docs/methods/messages_uninstallStickerSet.md +++ b/docs/API_docs/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/messages_uploadEncryptedFile.md b/docs/API_docs/methods/messages_uploadEncryptedFile.md index abb08479..91159bb5 100644 --- a/docs/API_docs/methods/messages_uploadEncryptedFile.md +++ b/docs/API_docs/methods/messages_uploadEncryptedFile.md @@ -11,10 +11,10 @@ Upload a secret chat file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to upload the media| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to upload the media | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file | Optional| ### Return type: [EncryptedFile](../types/EncryptedFile.md) diff --git a/docs/API_docs/methods/messages_uploadMedia.md b/docs/API_docs/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/docs/API_docs/methods/messages_uploadMedia.md +++ b/docs/API_docs/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/docs/API_docs/methods/payments_clearSavedInfo.md b/docs/API_docs/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/docs/API_docs/methods/payments_clearSavedInfo.md +++ b/docs/API_docs/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/payments_getPaymentForm.md b/docs/API_docs/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/docs/API_docs/methods/payments_getPaymentForm.md +++ b/docs/API_docs/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/docs/API_docs/methods/payments_getPaymentReceipt.md b/docs/API_docs/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/docs/API_docs/methods/payments_getPaymentReceipt.md +++ b/docs/API_docs/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/docs/API_docs/methods/payments_sendPaymentForm.md b/docs/API_docs/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/docs/API_docs/methods/payments_sendPaymentForm.md +++ b/docs/API_docs/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/docs/API_docs/methods/payments_validateRequestedInfo.md b/docs/API_docs/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/docs/API_docs/methods/payments_validateRequestedInfo.md +++ b/docs/API_docs/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/docs/API_docs/methods/phone_receivedCall.md b/docs/API_docs/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/docs/API_docs/methods/phone_receivedCall.md +++ b/docs/API_docs/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/phone_saveCallDebug.md b/docs/API_docs/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/docs/API_docs/methods/phone_saveCallDebug.md +++ b/docs/API_docs/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/API_docs/methods/phone_setCallRating.md b/docs/API_docs/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/docs/API_docs/methods/phone_setCallRating.md +++ b/docs/API_docs/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/docs/API_docs/methods/photos_deletePhotos.md b/docs/API_docs/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/docs/API_docs/methods/photos_deletePhotos.md +++ b/docs/API_docs/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/docs/API_docs/methods/photos_getUserPhotos.md b/docs/API_docs/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/docs/API_docs/methods/photos_getUserPhotos.md +++ b/docs/API_docs/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/docs/API_docs/methods/photos_updateProfilePhoto.md b/docs/API_docs/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/docs/API_docs/methods/photos_updateProfilePhoto.md +++ b/docs/API_docs/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/docs/API_docs/methods/photos_uploadProfilePhoto.md b/docs/API_docs/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/docs/API_docs/methods/photos_uploadProfilePhoto.md +++ b/docs/API_docs/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/docs/API_docs/methods/stickers_addStickerToSet.md b/docs/API_docs/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/docs/API_docs/methods/stickers_addStickerToSet.md +++ b/docs/API_docs/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/stickers_changeStickerPosition.md b/docs/API_docs/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/docs/API_docs/methods/stickers_changeStickerPosition.md +++ b/docs/API_docs/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/stickers_createStickerSet.md b/docs/API_docs/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/docs/API_docs/methods/stickers_createStickerSet.md +++ b/docs/API_docs/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/stickers_removeStickerFromSet.md b/docs/API_docs/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/docs/API_docs/methods/stickers_removeStickerFromSet.md +++ b/docs/API_docs/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/docs/API_docs/methods/upload_getWebFile.md b/docs/API_docs/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/docs/API_docs/methods/upload_getWebFile.md +++ b/docs/API_docs/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/docs/API_docs/methods/users_getUsers.md b/docs/API_docs/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/docs/API_docs/methods/users_getUsers.md +++ b/docs/API_docs/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/docs/API_docs/methods/users_setSecureValueErrors.md b/docs/API_docs/methods/users_setSecureValueErrors.md index 11293a49..4e18012c 100644 --- a/docs/API_docs/methods/users_setSecureValueErrors.md +++ b/docs/API_docs/methods/users_setSecureValueErrors.md @@ -11,10 +11,10 @@ Set secure value error for telegram passport ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|The errors| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | The errors | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/docs/MTProto_docs/methods/destroy_session.md b/docs/MTProto_docs/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/docs/MTProto_docs/methods/destroy_session.md +++ b/docs/MTProto_docs/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/docs/MTProto_docs/methods/get_future_salts.md b/docs/MTProto_docs/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/docs/MTProto_docs/methods/get_future_salts.md +++ b/docs/MTProto_docs/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/docs/MTProto_docs/methods/http_wait.md b/docs/MTProto_docs/methods/http_wait.md index a47e8863..4ebc446a 100644 --- a/docs/MTProto_docs/methods/http_wait.md +++ b/docs/MTProto_docs/methods/http_wait.md @@ -11,11 +11,11 @@ Makes the server send messages waiting in the buffer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_delay|[int](../types/int.md) | Yes|Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response| -|wait\_after|[int](../types/int.md) | Yes|after the receipt of the latest message for a particular session, the server waits another wait_after milliseconds in case there are more messages. If there are no additional messages, the result is transmitted (a container with all the messages).| -|max\_wait|[int](../types/int.md) | Yes|If more messages appear, the wait_after timer is reset.| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_delay|[int](../types/int.md) | Denotes the maximum number of milliseconds that has elapsed between the first message for this session and the transmission of an HTTP response | Yes| +|wait\_after|[int](../types/int.md) | after the receipt of the latest message for a particular session, the server waits another wait_after milliseconds in case there are more messages. If there are no additional messages, the result is transmitted (a container with all the messages). | Yes| +|max\_wait|[int](../types/int.md) | If more messages appear, the wait_after timer is reset. | Yes| ### Return type: [HttpWait](../types/HttpWait.md) diff --git a/docs/MTProto_docs/methods/ping.md b/docs/MTProto_docs/methods/ping.md index dadae42f..d07839e4 100644 --- a/docs/MTProto_docs/methods/ping.md +++ b/docs/MTProto_docs/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/docs/MTProto_docs/methods/ping_delay_disconnect.md b/docs/MTProto_docs/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/docs/MTProto_docs/methods/ping_delay_disconnect.md +++ b/docs/MTProto_docs/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/docs/MTProto_docs/methods/req_DH_params.md b/docs/MTProto_docs/methods/req_DH_params.md index 146831a4..dc5e40b0 100644 --- a/docs/MTProto_docs/methods/req_DH_params.md +++ b/docs/MTProto_docs/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[bytes](../types/bytes.md) | Yes|Factorized p from pq| -|q|[bytes](../types/bytes.md) | Yes|Factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[bytes](../types/bytes.md) | Yes|Encrypted key exchange message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[bytes](../types/bytes.md) | Factorized p from pq | Yes| +|q|[bytes](../types/bytes.md) | Factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[bytes](../types/bytes.md) | Encrypted key exchange message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/docs/MTProto_docs/methods/req_pq.md b/docs/MTProto_docs/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/docs/MTProto_docs/methods/req_pq.md +++ b/docs/MTProto_docs/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/docs/MTProto_docs/methods/req_pq_multi.md b/docs/MTProto_docs/methods/req_pq_multi.md index 1a366058..05193c0d 100644 --- a/docs/MTProto_docs/methods/req_pq_multi.md +++ b/docs/MTProto_docs/methods/req_pq_multi.md @@ -11,9 +11,9 @@ Requests PQ for factorization (new version) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/docs/MTProto_docs/methods/rpc_drop_answer.md b/docs/MTProto_docs/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/docs/MTProto_docs/methods/rpc_drop_answer.md +++ b/docs/MTProto_docs/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/docs/MTProto_docs/methods/set_client_DH_params.md b/docs/MTProto_docs/methods/set_client_DH_params.md index 2f2d3c52..7981af3e 100644 --- a/docs/MTProto_docs/methods/set_client_DH_params.md +++ b/docs/MTProto_docs/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[bytes](../types/bytes.md) | Yes|Encrypted key exchange message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[bytes](../types/bytes.md) | Encrypted key exchange message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/docs/TD_docs/methods/acceptCall.md b/docs/TD_docs/methods/acceptCall.md index bb6a2e11..649bf888 100644 --- a/docs/TD_docs/methods/acceptCall.md +++ b/docs/TD_docs/methods/acceptCall.md @@ -14,10 +14,10 @@ Accepts incoming call ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|call\_id|[int](../types/int.md) | Yes|Call identifier| -|protocol|[callProtocol](../constructors/callProtocol.md) | Yes|Description of supported by the client call protocols| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|call\_id|[int](../types/int.md) | Call identifier | Yes| +|protocol|[callProtocol](../constructors/callProtocol.md) | Description of supported by the client call protocols | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addChatMember.md b/docs/TD_docs/methods/addChatMember.md index 4d93b2e6..e1609e82 100644 --- a/docs/TD_docs/methods/addChatMember.md +++ b/docs/TD_docs/methods/addChatMember.md @@ -14,11 +14,11 @@ Adds new member to chat. Members can't be added to private or secret chats. Memb ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[int](../types/int.md) | Yes|Identifier of the user to add| -|forward\_limit|[int](../types/int.md) | Yes|Number of previous messages from chat to forward to new member, ignored for channel chats. Can't be greater than 300| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|user\_id|[int](../types/int.md) | Identifier of the user to add | Yes| +|forward\_limit|[int](../types/int.md) | Number of previous messages from chat to forward to new member, ignored for channel chats. Can't be greater than 300 | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addChatMembers.md b/docs/TD_docs/methods/addChatMembers.md index 1c63bc1f..aca0f8a3 100644 --- a/docs/TD_docs/methods/addChatMembers.md +++ b/docs/TD_docs/methods/addChatMembers.md @@ -14,10 +14,10 @@ Adds many new members to the chat. Currently, available only for channels. Can't ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of the users to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|user\_ids|Array of [int](../types/int.md) | Identifiers of the users to add | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addFavoriteSticker.md b/docs/TD_docs/methods/addFavoriteSticker.md index 80bd4b7f..8486975f 100644 --- a/docs/TD_docs/methods/addFavoriteSticker.md +++ b/docs/TD_docs/methods/addFavoriteSticker.md @@ -14,9 +14,9 @@ Adds new sticker to the list of favorite stickers. New sticker is added to the b ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[InputFile](../types/InputFile.md) | Sticker file to add | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addNetworkStatistics.md b/docs/TD_docs/methods/addNetworkStatistics.md index 73a075f9..9396846a 100644 --- a/docs/TD_docs/methods/addNetworkStatistics.md +++ b/docs/TD_docs/methods/addNetworkStatistics.md @@ -14,9 +14,9 @@ Adds specified data to data usage statistics. Can be called before authorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|entry|[NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) | Yes|Network statistics entry with a data to add to statistics| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|entry|[NetworkStatisticsEntry](../types/NetworkStatisticsEntry.md) | Network statistics entry with a data to add to statistics | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addRecentSticker.md b/docs/TD_docs/methods/addRecentSticker.md index 0f5b4756..088869b4 100644 --- a/docs/TD_docs/methods/addRecentSticker.md +++ b/docs/TD_docs/methods/addRecentSticker.md @@ -14,10 +14,10 @@ Manually adds new sticker to the list of recently used stickers. New sticker is ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to add the sticker to the list of stickers recently attached to photo or video files, pass false to add the sticker to the list of recently sent stickers| -|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_attached|[Bool](../types/Bool.md) | Pass true to add the sticker to the list of stickers recently attached to photo or video files, pass false to add the sticker to the list of recently sent stickers | Yes| +|sticker|[InputFile](../types/InputFile.md) | Sticker file to add | Yes| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/addRecentlyFoundChat.md b/docs/TD_docs/methods/addRecentlyFoundChat.md index 4bdc29cf..575d8d4f 100644 --- a/docs/TD_docs/methods/addRecentlyFoundChat.md +++ b/docs/TD_docs/methods/addRecentlyFoundChat.md @@ -14,9 +14,9 @@ Adds chat to the list of recently found chats. The chat is added to the beginnin ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat to add | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addSavedAnimation.md b/docs/TD_docs/methods/addSavedAnimation.md index 37b744d9..13cb0356 100644 --- a/docs/TD_docs/methods/addSavedAnimation.md +++ b/docs/TD_docs/methods/addSavedAnimation.md @@ -14,9 +14,9 @@ Manually adds new animation to the list of saved animations. New animation is ad ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|animation|[InputFile](../types/InputFile.md) | Yes|Animation file to add. Only known to server animations (i. e. successfully sent via message) can be added to the list| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|animation|[InputFile](../types/InputFile.md) | Animation file to add. Only known to server animations (i. e. successfully sent via message) can be added to the list | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/addStickerToSet.md b/docs/TD_docs/methods/addStickerToSet.md index 0c8eb185..51f2c051 100644 --- a/docs/TD_docs/methods/addStickerToSet.md +++ b/docs/TD_docs/methods/addStickerToSet.md @@ -14,11 +14,11 @@ Bots only. Adds new sticker to a set. Returns the sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|Sticker set owner| -|name|[string](../types/string.md) | Yes|Sticker set name| -|sticker|[inputSticker](../constructors/inputSticker.md) | Yes|Sticker to add to the set| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | Sticker set owner | Yes| +|name|[string](../types/string.md) | Sticker set name | Yes| +|sticker|[inputSticker](../constructors/inputSticker.md) | Sticker to add to the set | Yes| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/answerCallbackQuery.md b/docs/TD_docs/methods/answerCallbackQuery.md index e0d27599..081fba7e 100644 --- a/docs/TD_docs/methods/answerCallbackQuery.md +++ b/docs/TD_docs/methods/answerCallbackQuery.md @@ -14,13 +14,13 @@ Bots only. Sets result of a callback query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|callback\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the callback query| -|text|[string](../types/string.md) | Yes|Text of the answer| -|show\_alert|[Bool](../types/Bool.md) | Yes|If true, an alert should be shown to the user instead of a toast| -|url|[string](../types/string.md) | Yes|Url to be opened| -|cache\_time|[int](../types/int.md) | Yes|Allowed time to cache result of the query in seconds| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|callback\_query\_id|[int64](../constructors/int64.md) | Identifier of the callback query | Yes| +|text|[string](../types/string.md) | Text of the answer | Yes| +|show\_alert|[Bool](../types/Bool.md) | If true, an alert should be shown to the user instead of a toast | Yes| +|url|[string](../types/string.md) | Url to be opened | Yes| +|cache\_time|[int](../types/int.md) | Allowed time to cache result of the query in seconds | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerCustomQuery.md b/docs/TD_docs/methods/answerCustomQuery.md index 7b3bade9..30f380f2 100644 --- a/docs/TD_docs/methods/answerCustomQuery.md +++ b/docs/TD_docs/methods/answerCustomQuery.md @@ -14,10 +14,10 @@ Bots only. Answers a custom query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|custom\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of a custom query| -|data|[string](../types/string.md) | Yes|JSON-serialized answer to the query| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|custom\_query\_id|[int64](../constructors/int64.md) | Identifier of a custom query | Yes| +|data|[string](../types/string.md) | JSON-serialized answer to the query | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerInlineQuery.md b/docs/TD_docs/methods/answerInlineQuery.md index dca718e9..f770bd60 100644 --- a/docs/TD_docs/methods/answerInlineQuery.md +++ b/docs/TD_docs/methods/answerInlineQuery.md @@ -14,15 +14,15 @@ Bots only. Sets result of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|inline\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the inline query| -|is\_personal|[Bool](../types/Bool.md) | Yes|Does result of the query can be cached only for specified user| -|results|Array of [InputInlineQueryResult](../types/InputInlineQueryResult.md) | Yes|Results of the query| -|cache\_time|[int](../types/int.md) | Yes|Allowed time to cache results of the query in seconds| -|next\_offset|[string](../types/string.md) | Yes|Offset for the next inline query, pass empty string if there is no more results| -|switch\_pm\_text|[string](../types/string.md) | Yes|If non-empty, this text should be shown on the button, which opens private chat with the bot and sends bot start message with parameter switch_pm_parameter| -|switch\_pm\_parameter|[string](../types/string.md) | Yes|Parameter for the bot start message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|inline\_query\_id|[int64](../constructors/int64.md) | Identifier of the inline query | Yes| +|is\_personal|[Bool](../types/Bool.md) | Does result of the query can be cached only for specified user | Yes| +|results|Array of [InputInlineQueryResult](../types/InputInlineQueryResult.md) | Results of the query | Yes| +|cache\_time|[int](../types/int.md) | Allowed time to cache results of the query in seconds | Yes| +|next\_offset|[string](../types/string.md) | Offset for the next inline query, pass empty string if there is no more results | Yes| +|switch\_pm\_text|[string](../types/string.md) | If non-empty, this text should be shown on the button, which opens private chat with the bot and sends bot start message with parameter switch_pm_parameter | Yes| +|switch\_pm\_parameter|[string](../types/string.md) | Parameter for the bot start message | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerPreCheckoutQuery.md b/docs/TD_docs/methods/answerPreCheckoutQuery.md index 96a694ae..b8906d92 100644 --- a/docs/TD_docs/methods/answerPreCheckoutQuery.md +++ b/docs/TD_docs/methods/answerPreCheckoutQuery.md @@ -14,10 +14,10 @@ Bots only. Sets result of a pre checkout query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pre\_checkout\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the pre-checkout query| -|error\_message|[string](../types/string.md) | Yes|Error message, empty on success| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pre\_checkout\_query\_id|[int64](../constructors/int64.md) | Identifier of the pre-checkout query | Yes| +|error\_message|[string](../types/string.md) | Error message, empty on success | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/answerShippingQuery.md b/docs/TD_docs/methods/answerShippingQuery.md index bdcf0ea5..a27a450a 100644 --- a/docs/TD_docs/methods/answerShippingQuery.md +++ b/docs/TD_docs/methods/answerShippingQuery.md @@ -14,11 +14,11 @@ Bots only. Sets result of a shipping query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|shipping\_query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the shipping query| -|shipping\_options|Array of [shippingOption](../constructors/shippingOption.md) | Yes|Available shipping options| -|error\_message|[string](../types/string.md) | Yes|Error message, empty on success| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|shipping\_query\_id|[int64](../constructors/int64.md) | Identifier of the shipping query | Yes| +|shipping\_options|Array of [shippingOption](../constructors/shippingOption.md) | Available shipping options | Yes| +|error\_message|[string](../types/string.md) | Error message, empty on success | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/blockUser.md b/docs/TD_docs/methods/blockUser.md index 509381b2..cd48caeb 100644 --- a/docs/TD_docs/methods/blockUser.md +++ b/docs/TD_docs/methods/blockUser.md @@ -14,9 +14,9 @@ Adds user to black list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/cancelDownloadFile.md b/docs/TD_docs/methods/cancelDownloadFile.md index ac1b4946..a7df984f 100644 --- a/docs/TD_docs/methods/cancelDownloadFile.md +++ b/docs/TD_docs/methods/cancelDownloadFile.md @@ -14,9 +14,9 @@ Stops file downloading. If file is already downloaded, does nothing ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_id|[int](../types/int.md) | Yes|Identifier of file to cancel download| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[int](../types/int.md) | Identifier of file to cancel download | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/cancelUploadFile.md b/docs/TD_docs/methods/cancelUploadFile.md index 267a4964..03368add 100644 --- a/docs/TD_docs/methods/cancelUploadFile.md +++ b/docs/TD_docs/methods/cancelUploadFile.md @@ -14,9 +14,9 @@ Stops file uploading. Works only for files uploaded using uploadFile. For other ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_id|[int](../types/int.md) | Yes|Identifier of file to cancel upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[int](../types/int.md) | Identifier of file to cancel upload | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeAbout.md b/docs/TD_docs/methods/changeAbout.md index 10afac57..a0d4cf1c 100644 --- a/docs/TD_docs/methods/changeAbout.md +++ b/docs/TD_docs/methods/changeAbout.md @@ -14,9 +14,9 @@ Changes about information of logged in user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|about|[string](../types/string.md) | Yes|New value of userFull.about, 0-70 characters without line feeds| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|about|[string](../types/string.md) | New value of userFull.about, 0-70 characters without line feeds | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeAccountTtl.md b/docs/TD_docs/methods/changeAccountTtl.md index e31565c1..540e5db5 100644 --- a/docs/TD_docs/methods/changeAccountTtl.md +++ b/docs/TD_docs/methods/changeAccountTtl.md @@ -14,9 +14,9 @@ Changes period of inactivity, after which the account of currently logged in use ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ttl|[accountTtl](../constructors/accountTtl.md) | Yes|New account TTL| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ttl|[accountTtl](../constructors/accountTtl.md) | New account TTL | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChannelDescription.md b/docs/TD_docs/methods/changeChannelDescription.md index 0a314b16..1c2f4bfb 100644 --- a/docs/TD_docs/methods/changeChannelDescription.md +++ b/docs/TD_docs/methods/changeChannelDescription.md @@ -14,10 +14,10 @@ Changes information about the channel. Needs appropriate rights in the channel ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|description|[string](../types/string.md) | Yes|New channel description, 0-255 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|description|[string](../types/string.md) | New channel description, 0-255 characters | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChannelUsername.md b/docs/TD_docs/methods/changeChannelUsername.md index d8d577b8..97531e85 100644 --- a/docs/TD_docs/methods/changeChannelUsername.md +++ b/docs/TD_docs/methods/changeChannelUsername.md @@ -14,10 +14,10 @@ Changes username of the channel. Needs creator privileges in the channel ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|username|[string](../types/string.md) | Yes|New value of username. Use empty string to remove username| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|username|[string](../types/string.md) | New value of username. Use empty string to remove username | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatDraftMessage.md b/docs/TD_docs/methods/changeChatDraftMessage.md index 5a7f2ea4..c0fe3faf 100644 --- a/docs/TD_docs/methods/changeChatDraftMessage.md +++ b/docs/TD_docs/methods/changeChatDraftMessage.md @@ -14,10 +14,10 @@ Changes chat draft message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|draft\_message|[draftMessage](../constructors/draftMessage.md) | Yes|New draft message, nullable| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|draft\_message|[draftMessage](../constructors/draftMessage.md) | New draft message, nullable | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatMemberStatus.md b/docs/TD_docs/methods/changeChatMemberStatus.md index 57bbea08..604f5813 100644 --- a/docs/TD_docs/methods/changeChatMemberStatus.md +++ b/docs/TD_docs/methods/changeChatMemberStatus.md @@ -14,11 +14,11 @@ Changes status of the chat member, need appropriate privileges. This function is ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[int](../types/int.md) | Yes|Identifier of the user to edit status| -|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | Yes|New status of the member in the chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|user\_id|[int](../types/int.md) | Identifier of the user to edit status | Yes| +|status|[ChatMemberStatus](../types/ChatMemberStatus.md) | New status of the member in the chat | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatPhoto.md b/docs/TD_docs/methods/changeChatPhoto.md index 66146a71..866e7764 100644 --- a/docs/TD_docs/methods/changeChatPhoto.md +++ b/docs/TD_docs/methods/changeChatPhoto.md @@ -14,10 +14,10 @@ Changes chat photo. Works only for group and channel chats. Requires administrat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|photo|[InputFile](../types/InputFile.md) | Yes|New chat photo. You can use zero InputFileId to delete chat photo. Files accessible only by HTTP URL are not acceptable| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|photo|[InputFile](../types/InputFile.md) | New chat photo. You can use zero InputFileId to delete chat photo. Files accessible only by HTTP URL are not acceptable | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatReportSpamState.md b/docs/TD_docs/methods/changeChatReportSpamState.md index 7ee2af97..224b5a3b 100644 --- a/docs/TD_docs/methods/changeChatReportSpamState.md +++ b/docs/TD_docs/methods/changeChatReportSpamState.md @@ -14,10 +14,10 @@ Reports chat as a spam chat or as not a spam chat. Can be used only if ChatRepor ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|is\_spam\_chat|[Bool](../types/Bool.md) | Yes|If true, chat will be reported as a spam chat, otherwise it will be marked as not a spam chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|is\_spam\_chat|[Bool](../types/Bool.md) | If true, chat will be reported as a spam chat, otherwise it will be marked as not a spam chat | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeChatTitle.md b/docs/TD_docs/methods/changeChatTitle.md index ce5f53e4..555873c1 100644 --- a/docs/TD_docs/methods/changeChatTitle.md +++ b/docs/TD_docs/methods/changeChatTitle.md @@ -14,10 +14,10 @@ Changes chat title. Works only for group and channel chats. Requires administrat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|title|[string](../types/string.md) | Yes|New title of the chat, 1-255 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|title|[string](../types/string.md) | New title of the chat, 1-255 characters | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeName.md b/docs/TD_docs/methods/changeName.md index b07c028a..5d358ff1 100644 --- a/docs/TD_docs/methods/changeName.md +++ b/docs/TD_docs/methods/changeName.md @@ -14,10 +14,10 @@ Changes first and last names of logged in user. If something changes, updateUser ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|New value of user first name, 1-255 characters| -|last\_name|[string](../types/string.md) | Yes|New value of optional user last name, 0-255 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | New value of user first name, 1-255 characters | Yes| +|last\_name|[string](../types/string.md) | New value of optional user last name, 0-255 characters | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changePhoneNumber.md b/docs/TD_docs/methods/changePhoneNumber.md index 33495ad1..e4ca820e 100644 --- a/docs/TD_docs/methods/changePhoneNumber.md +++ b/docs/TD_docs/methods/changePhoneNumber.md @@ -14,11 +14,11 @@ Changes user's phone number and sends authentication code to the new user's phon ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New user's phone number in any reasonable format| -|allow\_flash\_call|[Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number| -|is\_current\_phone\_number|[Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New user's phone number in any reasonable format | Yes| +|allow\_flash\_call|[Bool](../types/Bool.md) | Pass True, if code can be sent via flash call to the specified phone number | Yes| +|is\_current\_phone\_number|[Bool](../types/Bool.md) | Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/changeStickerSet.md b/docs/TD_docs/methods/changeStickerSet.md index 5cfde26d..2be9760b 100644 --- a/docs/TD_docs/methods/changeStickerSet.md +++ b/docs/TD_docs/methods/changeStickerSet.md @@ -14,11 +14,11 @@ Installs/uninstalls or enables/archives sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|set\_id|[int64](../constructors/int64.md) | Yes|Identifier of the sticker set| -|is\_installed|[Bool](../types/Bool.md) | Yes|New value of is_installed| -|is\_archived|[Bool](../types/Bool.md) | Yes|New value of is_archived. A sticker set can't be installed and archived simultaneously| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|set\_id|[int64](../constructors/int64.md) | Identifier of the sticker set | Yes| +|is\_installed|[Bool](../types/Bool.md) | New value of is_installed | Yes| +|is\_archived|[Bool](../types/Bool.md) | New value of is_archived. A sticker set can't be installed and archived simultaneously | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/changeUsername.md b/docs/TD_docs/methods/changeUsername.md index 00689d65..a1721522 100644 --- a/docs/TD_docs/methods/changeUsername.md +++ b/docs/TD_docs/methods/changeUsername.md @@ -14,9 +14,9 @@ Changes username of logged in user. If something changes, updateUser will be sen ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|username|[string](../types/string.md) | Yes|New value of username. Use empty string to remove username| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|username|[string](../types/string.md) | New value of username. Use empty string to remove username | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/checkAuthBotToken.md b/docs/TD_docs/methods/checkAuthBotToken.md index c3dc30ac..aa9206ed 100644 --- a/docs/TD_docs/methods/checkAuthBotToken.md +++ b/docs/TD_docs/methods/checkAuthBotToken.md @@ -14,9 +14,9 @@ Check bot's authentication token to log in as a bot. Works only when getAuthStat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|token|[string](../types/string.md) | Yes|Bot token| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|token|[string](../types/string.md) | Bot token | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkAuthCode.md b/docs/TD_docs/methods/checkAuthCode.md index 8dd7a968..13d055eb 100644 --- a/docs/TD_docs/methods/checkAuthCode.md +++ b/docs/TD_docs/methods/checkAuthCode.md @@ -14,11 +14,11 @@ Checks authentication code. Works only when getAuthState returns authStateWaitCo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|code|[string](../types/string.md) | Yes|Verification code from SMS, Telegram message, phone call or flash call| -|first\_name|[string](../types/string.md) | Yes|User first name, if user is yet not registered, 1-255 characters| -|last\_name|[string](../types/string.md) | Yes|Optional user last name, if user is yet not registered, 0-255 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|code|[string](../types/string.md) | Verification code from SMS, Telegram message, phone call or flash call | Yes| +|first\_name|[string](../types/string.md) | User first name, if user is yet not registered, 1-255 characters | Yes| +|last\_name|[string](../types/string.md) | Optional user last name, if user is yet not registered, 0-255 characters | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkAuthPassword.md b/docs/TD_docs/methods/checkAuthPassword.md index 9e23bfc4..6cd11549 100644 --- a/docs/TD_docs/methods/checkAuthPassword.md +++ b/docs/TD_docs/methods/checkAuthPassword.md @@ -14,9 +14,9 @@ Checks password for correctness. Works only when getAuthState returns authStateW ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|password|[string](../types/string.md) | Yes|Password to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[string](../types/string.md) | Password to check | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkChangePhoneNumberCode.md b/docs/TD_docs/methods/checkChangePhoneNumberCode.md index 2502a9ee..8337e6d7 100644 --- a/docs/TD_docs/methods/checkChangePhoneNumberCode.md +++ b/docs/TD_docs/methods/checkChangePhoneNumberCode.md @@ -14,9 +14,9 @@ Checks authentication code sent to change user's phone number. Returns authState ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|code|[string](../types/string.md) | Yes|Verification code from SMS, phone call or flash call| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|code|[string](../types/string.md) | Verification code from SMS, phone call or flash call | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/checkChatInviteLink.md b/docs/TD_docs/methods/checkChatInviteLink.md index 951dad58..a7569e85 100644 --- a/docs/TD_docs/methods/checkChatInviteLink.md +++ b/docs/TD_docs/methods/checkChatInviteLink.md @@ -14,9 +14,9 @@ Checks chat invite link for validness and returns information about the correspo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|invite\_link|[string](../types/string.md) | Yes|Invite link to check. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|invite\_link|[string](../types/string.md) | Invite link to check. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/" | Yes| ### Return type: [ChatInviteLinkInfo](../types/ChatInviteLinkInfo.md) diff --git a/docs/TD_docs/methods/clearRecentStickers.md b/docs/TD_docs/methods/clearRecentStickers.md index a7a089cb..7a99682e 100644 --- a/docs/TD_docs/methods/clearRecentStickers.md +++ b/docs/TD_docs/methods/clearRecentStickers.md @@ -14,9 +14,9 @@ Clears list of recently used stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to clear list of stickers recently attached to photo or video files, pass false to clear the list of recently sent stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_attached|[Bool](../types/Bool.md) | Pass true to clear list of stickers recently attached to photo or video files, pass false to clear the list of recently sent stickers | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/closeChat.md b/docs/TD_docs/methods/closeChat.md index e49de63f..e8e8cf4b 100644 --- a/docs/TD_docs/methods/closeChat.md +++ b/docs/TD_docs/methods/closeChat.md @@ -14,9 +14,9 @@ Chat is closed by the user. Many useful activities depends on chat being opened ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/closeSecretChat.md b/docs/TD_docs/methods/closeSecretChat.md index 36efede1..5cd82c5f 100644 --- a/docs/TD_docs/methods/closeSecretChat.md +++ b/docs/TD_docs/methods/closeSecretChat.md @@ -14,9 +14,9 @@ Closes secret chat, effectively transfering its state to "Closed" ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|secret\_chat\_id|[int](../types/int.md) | Yes|Secret chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|secret\_chat\_id|[int](../types/int.md) | Secret chat identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/createCall.md b/docs/TD_docs/methods/createCall.md index c677ad36..e806a1e4 100644 --- a/docs/TD_docs/methods/createCall.md +++ b/docs/TD_docs/methods/createCall.md @@ -14,10 +14,10 @@ Creates new call ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|Identifier of user to call| -|protocol|[callProtocol](../constructors/callProtocol.md) | Yes|Description of supported by the client call protocols| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | Identifier of user to call | Yes| +|protocol|[callProtocol](../constructors/callProtocol.md) | Description of supported by the client call protocols | Yes| ### Return type: [CallId](../types/CallId.md) diff --git a/docs/TD_docs/methods/createChannelChat.md b/docs/TD_docs/methods/createChannelChat.md index a49ff21d..1a5ce917 100644 --- a/docs/TD_docs/methods/createChannelChat.md +++ b/docs/TD_docs/methods/createChannelChat.md @@ -14,9 +14,9 @@ Returns existing chat corresponding to the known channel ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Channel identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Channel identifier | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createGroupChat.md b/docs/TD_docs/methods/createGroupChat.md index b4881e4d..c7b7f371 100644 --- a/docs/TD_docs/methods/createGroupChat.md +++ b/docs/TD_docs/methods/createGroupChat.md @@ -14,9 +14,9 @@ Returns existing chat corresponding to the known group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|group\_id|[int](../types/int.md) | Yes|Group identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|group\_id|[int](../types/int.md) | Group identifier | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewChannelChat.md b/docs/TD_docs/methods/createNewChannelChat.md index 5facf4a3..4d6cddfe 100644 --- a/docs/TD_docs/methods/createNewChannelChat.md +++ b/docs/TD_docs/methods/createNewChannelChat.md @@ -14,11 +14,11 @@ Creates new channel chat and send corresponding messageChannelChatCreate, return ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Title of new channel chat, 1-255 characters| -|is\_supergroup|[Bool](../types/Bool.md) | Yes|True, if supergroup chat should be created| -|description|[string](../types/string.md) | Yes|Channel description, 0-255 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|title|[string](../types/string.md) | Title of new channel chat, 1-255 characters | Yes| +|is\_supergroup|[Bool](../types/Bool.md) | True, if supergroup chat should be created | Yes| +|description|[string](../types/string.md) | Channel description, 0-255 characters | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewGroupChat.md b/docs/TD_docs/methods/createNewGroupChat.md index a97178f0..62b4752f 100644 --- a/docs/TD_docs/methods/createNewGroupChat.md +++ b/docs/TD_docs/methods/createNewGroupChat.md @@ -14,10 +14,10 @@ Creates new group chat and send corresponding messageGroupChatCreate, returns cr ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of users to add to the group| -|title|[string](../types/string.md) | Yes|Title of new group chat, 1-255 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_ids|Array of [int](../types/int.md) | Identifiers of users to add to the group | Yes| +|title|[string](../types/string.md) | Title of new group chat, 1-255 characters | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewSecretChat.md b/docs/TD_docs/methods/createNewSecretChat.md index 9f075648..0dcb0dad 100644 --- a/docs/TD_docs/methods/createNewSecretChat.md +++ b/docs/TD_docs/methods/createNewSecretChat.md @@ -14,9 +14,9 @@ Creates new secret chat, returns created chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|Identifier of a user to create secret chat with| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | Identifier of a user to create secret chat with | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createNewStickerSet.md b/docs/TD_docs/methods/createNewStickerSet.md index 88d32b5c..b09ae7c4 100644 --- a/docs/TD_docs/methods/createNewStickerSet.md +++ b/docs/TD_docs/methods/createNewStickerSet.md @@ -14,13 +14,13 @@ Bots only. Creates new sticker set. Returns created sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|Sticker set owner| -|title|[string](../types/string.md) | Yes|Sticker set title, 1-64 characters| -|name|[string](../types/string.md) | Yes|Sticker set name. Can contain only english letters, digits and underscores. Should end on *"_by_"*. ** is case insensitive, 1-64 characters| -|is\_masks|[Bool](../types/Bool.md) | Yes|True, is stickers are masks| -|stickers|Array of [inputSticker](../constructors/inputSticker.md) | Yes|List of stickers to add to the set| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | Sticker set owner | Yes| +|title|[string](../types/string.md) | Sticker set title, 1-64 characters | Yes| +|name|[string](../types/string.md) | Sticker set name. Can contain only english letters, digits and underscores. Should end on *"_by_"*. ** is case insensitive, 1-64 characters | Yes| +|is\_masks|[Bool](../types/Bool.md) | True, is stickers are masks | Yes| +|stickers|Array of [inputSticker](../constructors/inputSticker.md) | List of stickers to add to the set | Yes| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/createPrivateChat.md b/docs/TD_docs/methods/createPrivateChat.md index a73acd27..e0743235 100644 --- a/docs/TD_docs/methods/createPrivateChat.md +++ b/docs/TD_docs/methods/createPrivateChat.md @@ -14,9 +14,9 @@ Returns existing chat corresponding to the given user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createSecretChat.md b/docs/TD_docs/methods/createSecretChat.md index 95073492..3e533731 100644 --- a/docs/TD_docs/methods/createSecretChat.md +++ b/docs/TD_docs/methods/createSecretChat.md @@ -14,9 +14,9 @@ Returns existing chat corresponding to the known secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|secret\_chat\_id|[int](../types/int.md) | Yes|SecretChat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|secret\_chat\_id|[int](../types/int.md) | SecretChat identifier | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/createTemporaryPassword.md b/docs/TD_docs/methods/createTemporaryPassword.md index a110c7fa..08ee6d6d 100644 --- a/docs/TD_docs/methods/createTemporaryPassword.md +++ b/docs/TD_docs/methods/createTemporaryPassword.md @@ -14,10 +14,10 @@ Creates new temporary password for payments processing ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|password|[string](../types/string.md) | Yes|Persistent user password| -|valid\_for|[int](../types/int.md) | Yes|Time before temporary password will expire, seconds. Should be between 60 and 86400| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[string](../types/string.md) | Persistent user password | Yes| +|valid\_for|[int](../types/int.md) | Time before temporary password will expire, seconds. Should be between 60 and 86400 | Yes| ### Return type: [TemporaryPasswordState](../types/TemporaryPasswordState.md) diff --git a/docs/TD_docs/methods/debugCall.md b/docs/TD_docs/methods/debugCall.md index 62b591b8..25b9ad67 100644 --- a/docs/TD_docs/methods/debugCall.md +++ b/docs/TD_docs/methods/debugCall.md @@ -14,10 +14,10 @@ Sends call debug information ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|call\_id|[int](../types/int.md) | Yes|Call identifier| -|debug|[string](../types/string.md) | Yes|Debug information in application specific format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|call\_id|[int](../types/int.md) | Call identifier | Yes| +|debug|[string](../types/string.md) | Debug information in application specific format | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteAccount.md b/docs/TD_docs/methods/deleteAccount.md index 07d7ab86..109f1552 100644 --- a/docs/TD_docs/methods/deleteAccount.md +++ b/docs/TD_docs/methods/deleteAccount.md @@ -14,9 +14,9 @@ Deletes the account of currently logged in user, deleting from the server all in ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|reason|[string](../types/string.md) | Yes|Optional reason of account deletion| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|reason|[string](../types/string.md) | Optional reason of account deletion | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteChannel.md b/docs/TD_docs/methods/deleteChannel.md index c2b02c10..4bdc9492 100644 --- a/docs/TD_docs/methods/deleteChannel.md +++ b/docs/TD_docs/methods/deleteChannel.md @@ -14,9 +14,9 @@ Deletes channel along with all messages in corresponding chat. Releases channel ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteChatHistory.md b/docs/TD_docs/methods/deleteChatHistory.md index 8c0312df..cab033b8 100644 --- a/docs/TD_docs/methods/deleteChatHistory.md +++ b/docs/TD_docs/methods/deleteChatHistory.md @@ -14,10 +14,10 @@ Deletes all messages in the chat. Can't be used for channel chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|remove\_from\_chat\_list|[Bool](../types/Bool.md) | Yes|Pass true, if chat should be removed from the chat list| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|remove\_from\_chat\_list|[Bool](../types/Bool.md) | Pass true, if chat should be removed from the chat list | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteChatReplyMarkup.md b/docs/TD_docs/methods/deleteChatReplyMarkup.md index 68079d97..de73f855 100644 --- a/docs/TD_docs/methods/deleteChatReplyMarkup.md +++ b/docs/TD_docs/methods/deleteChatReplyMarkup.md @@ -14,10 +14,10 @@ Deletes default reply markup from chat. This method needs to be called after one ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|message\_id|[int53](../types/int53.md) | Yes|Message identifier of used keyboard| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|message\_id|[int53](../types/int53.md) | Message identifier of used keyboard | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteContacts.md b/docs/TD_docs/methods/deleteContacts.md index 458f6691..878c8b7e 100644 --- a/docs/TD_docs/methods/deleteContacts.md +++ b/docs/TD_docs/methods/deleteContacts.md @@ -14,9 +14,9 @@ Deletes users from contacts list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_ids|Array of [int](../types/int.md) | Yes|Identifiers of users to be deleted| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_ids|Array of [int](../types/int.md) | Identifiers of users to be deleted | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteFavoriteSticker.md b/docs/TD_docs/methods/deleteFavoriteSticker.md index 12e87711..d4074465 100644 --- a/docs/TD_docs/methods/deleteFavoriteSticker.md +++ b/docs/TD_docs/methods/deleteFavoriteSticker.md @@ -14,9 +14,9 @@ Removes a sticker from the list of favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to delete from the list| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[InputFile](../types/InputFile.md) | Sticker file to delete from the list | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteFile.md b/docs/TD_docs/methods/deleteFile.md index 90ce457f..1fe68400 100644 --- a/docs/TD_docs/methods/deleteFile.md +++ b/docs/TD_docs/methods/deleteFile.md @@ -14,9 +14,9 @@ Deletes a file from TDLib file cache ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_id|[int](../types/int.md) | Yes|Identifier of the file to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[int](../types/int.md) | Identifier of the file to delete | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteMessages.md b/docs/TD_docs/methods/deleteMessages.md index 365330f4..9e8f985d 100644 --- a/docs/TD_docs/methods/deleteMessages.md +++ b/docs/TD_docs/methods/deleteMessages.md @@ -14,11 +14,11 @@ Deletes messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages to delete| -|revoke|[Bool](../types/Bool.md) | Yes|Pass true to try to delete sent messages for all chat members (may fail if messages are too old). Is always true for Channels and SecretChats| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|message\_ids|Array of [int53](../types/int53.md) | Identifiers of messages to delete | Yes| +|revoke|[Bool](../types/Bool.md) | Pass true to try to delete sent messages for all chat members (may fail if messages are too old). Is always true for Channels and SecretChats | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteMessagesFromUser.md b/docs/TD_docs/methods/deleteMessagesFromUser.md index 9d2fcc3c..d1b03b68 100644 --- a/docs/TD_docs/methods/deleteMessagesFromUser.md +++ b/docs/TD_docs/methods/deleteMessagesFromUser.md @@ -14,10 +14,10 @@ Deletes all messages in the chat sent by the specified user. Works only in super ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteProfilePhoto.md b/docs/TD_docs/methods/deleteProfilePhoto.md index 462e3c40..cab233d9 100644 --- a/docs/TD_docs/methods/deleteProfilePhoto.md +++ b/docs/TD_docs/methods/deleteProfilePhoto.md @@ -14,9 +14,9 @@ Deletes profile photo. If something changes, updateUser will be sent ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|profile\_photo\_id|[int64](../constructors/int64.md) | Yes|Identifier of profile photo to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|profile\_photo\_id|[int64](../constructors/int64.md) | Identifier of profile photo to delete | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteRecentHashtag.md b/docs/TD_docs/methods/deleteRecentHashtag.md index 9eef6c6c..38faadba 100644 --- a/docs/TD_docs/methods/deleteRecentHashtag.md +++ b/docs/TD_docs/methods/deleteRecentHashtag.md @@ -14,9 +14,9 @@ Deletes a hashtag from the list of recently used hashtags ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hashtag|[string](../types/string.md) | Yes|The hashtag to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hashtag|[string](../types/string.md) | The hashtag to delete | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteRecentSticker.md b/docs/TD_docs/methods/deleteRecentSticker.md index 8fb5f85e..233151e4 100644 --- a/docs/TD_docs/methods/deleteRecentSticker.md +++ b/docs/TD_docs/methods/deleteRecentSticker.md @@ -14,10 +14,10 @@ Removes a sticker from the list of recently used stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to remove the sticker from the list of stickers recently attached to photo or video files, pass false to remove the sticker from the list of recently sent stickers| -|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_attached|[Bool](../types/Bool.md) | Pass true to remove the sticker from the list of stickers recently attached to photo or video files, pass false to remove the sticker from the list of recently sent stickers | Yes| +|sticker|[InputFile](../types/InputFile.md) | Sticker file to delete | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteRecentlyFoundChat.md b/docs/TD_docs/methods/deleteRecentlyFoundChat.md index c3ee8d13..7b2f3d81 100644 --- a/docs/TD_docs/methods/deleteRecentlyFoundChat.md +++ b/docs/TD_docs/methods/deleteRecentlyFoundChat.md @@ -14,9 +14,9 @@ Deletes chat from the list of recently found chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat to delete | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteSavedAnimation.md b/docs/TD_docs/methods/deleteSavedAnimation.md index d72384d7..60d387d9 100644 --- a/docs/TD_docs/methods/deleteSavedAnimation.md +++ b/docs/TD_docs/methods/deleteSavedAnimation.md @@ -14,9 +14,9 @@ Removes an animation from the list of saved animations ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|animation|[InputFile](../types/InputFile.md) | Yes|Animation file to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|animation|[InputFile](../types/InputFile.md) | Animation file to delete | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteStickerFromSet.md b/docs/TD_docs/methods/deleteStickerFromSet.md index 2d5044dc..0c862a7c 100644 --- a/docs/TD_docs/methods/deleteStickerFromSet.md +++ b/docs/TD_docs/methods/deleteStickerFromSet.md @@ -14,9 +14,9 @@ Bots only. Deletes a sticker from the set it belongs to. Sticker set should be c ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[InputFile](../types/InputFile.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[InputFile](../types/InputFile.md) | The sticker | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/deleteTopChat.md b/docs/TD_docs/methods/deleteTopChat.md index e1f86c04..9a7b6daa 100644 --- a/docs/TD_docs/methods/deleteTopChat.md +++ b/docs/TD_docs/methods/deleteTopChat.md @@ -14,10 +14,10 @@ Delete a chat from a list of frequently used chats. Supported only if chat info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|category|[TopChatCategory](../types/TopChatCategory.md) | Yes|Category of frequently used chats| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|category|[TopChatCategory](../types/TopChatCategory.md) | Category of frequently used chats | Yes| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/discardCall.md b/docs/TD_docs/methods/discardCall.md index 49a25f59..d072a662 100644 --- a/docs/TD_docs/methods/discardCall.md +++ b/docs/TD_docs/methods/discardCall.md @@ -14,12 +14,12 @@ Discards a call ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|call\_id|[int](../types/int.md) | Yes|Call identifier| -|is\_disconnected|[Bool](../types/Bool.md) | Yes|True, if users was disconnected| -|duration|[int](../types/int.md) | Yes|Call duration in seconds| -|connection\_id|[int64](../constructors/int64.md) | Yes|Identifier of a connection used during the call| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|call\_id|[int](../types/int.md) | Call identifier | Yes| +|is\_disconnected|[Bool](../types/Bool.md) | True, if users was disconnected | Yes| +|duration|[int](../types/int.md) | Call duration in seconds | Yes| +|connection\_id|[int64](../constructors/int64.md) | Identifier of a connection used during the call | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/downloadFile.md b/docs/TD_docs/methods/downloadFile.md index e28aa743..7c40dff7 100644 --- a/docs/TD_docs/methods/downloadFile.md +++ b/docs/TD_docs/methods/downloadFile.md @@ -14,10 +14,10 @@ Asynchronously downloads file from cloud. Updates updateFile will notify about d ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_id|[int](../types/int.md) | Yes|Identifier of file to download| -|priority|[int](../types/int.md) | Yes|Priority of download, 1-32. The higher priority, the earlier file will be downloaded. If priorities of two files are equal then the last one for which downloadFile is called will be downloaded first| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[int](../types/int.md) | Identifier of file to download | Yes| +|priority|[int](../types/int.md) | Priority of download, 1-32. The higher priority, the earlier file will be downloaded. If priorities of two files are equal then the last one for which downloadFile is called will be downloaded first | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editInlineMessageCaption.md b/docs/TD_docs/methods/editInlineMessageCaption.md index 4acf46c8..88845824 100644 --- a/docs/TD_docs/methods/editInlineMessageCaption.md +++ b/docs/TD_docs/methods/editInlineMessageCaption.md @@ -14,11 +14,11 @@ Bots only. Edits caption of an inline message content sent via bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| -|caption|[string](../types/string.md) | Yes|New message content caption, 0-200 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|inline\_message\_id|[string](../types/string.md) | Inline message identifier | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | New message reply markup | Yes| +|caption|[string](../types/string.md) | New message content caption, 0-200 characters | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editInlineMessageReplyMarkup.md b/docs/TD_docs/methods/editInlineMessageReplyMarkup.md index 59500ffb..669528bb 100644 --- a/docs/TD_docs/methods/editInlineMessageReplyMarkup.md +++ b/docs/TD_docs/methods/editInlineMessageReplyMarkup.md @@ -14,10 +14,10 @@ Bots only. Edits reply markup of an inline message sent via bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|inline\_message\_id|[string](../types/string.md) | Inline message identifier | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | New message reply markup | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editInlineMessageText.md b/docs/TD_docs/methods/editInlineMessageText.md index 05d06380..801a41b9 100644 --- a/docs/TD_docs/methods/editInlineMessageText.md +++ b/docs/TD_docs/methods/editInlineMessageText.md @@ -14,11 +14,11 @@ Bots only. Edits text of an inline text or game message sent via bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| -|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|inline\_message\_id|[string](../types/string.md) | Inline message identifier | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | New message reply markup | Yes| +|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | New text content of the message. Should be of type InputMessageText | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/editMessageCaption.md b/docs/TD_docs/methods/editMessageCaption.md index 432c86b5..e45cbe4a 100644 --- a/docs/TD_docs/methods/editMessageCaption.md +++ b/docs/TD_docs/methods/editMessageCaption.md @@ -14,12 +14,12 @@ Edits message content caption. Non-bots can edit message in a limited period of ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat the message belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| -|caption|[string](../types/string.md) | Yes|New message content caption, 0-200 characters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat the message belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Bots only. New message reply markup | Yes| +|caption|[string](../types/string.md) | New message content caption, 0-200 characters | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/editMessageReplyMarkup.md b/docs/TD_docs/methods/editMessageReplyMarkup.md index 6c2af78b..da3caf70 100644 --- a/docs/TD_docs/methods/editMessageReplyMarkup.md +++ b/docs/TD_docs/methods/editMessageReplyMarkup.md @@ -14,11 +14,11 @@ Bots only. Edits message reply markup. Returns edited message after edit is comp ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat the message belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|New message reply markup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat the message belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | New message reply markup | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/editMessageText.md b/docs/TD_docs/methods/editMessageText.md index db44667a..f9878217 100644 --- a/docs/TD_docs/methods/editMessageText.md +++ b/docs/TD_docs/methods/editMessageText.md @@ -14,12 +14,12 @@ Edits text of text or game message. Non-bots can edit message in a limited perio ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat the message belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. New message reply markup| -|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|New text content of the message. Should be of type InputMessageText| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat the message belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Bots only. New message reply markup | Yes| +|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | New text content of the message. Should be of type InputMessageText | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/exportChatInviteLink.md b/docs/TD_docs/methods/exportChatInviteLink.md index c0c839ca..02c28b0d 100644 --- a/docs/TD_docs/methods/exportChatInviteLink.md +++ b/docs/TD_docs/methods/exportChatInviteLink.md @@ -14,9 +14,9 @@ Generates new chat invite link, previously generated link is revoked. Available ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [ChatInviteLink](../types/ChatInviteLink.md) diff --git a/docs/TD_docs/methods/finishFileGeneration.md b/docs/TD_docs/methods/finishFileGeneration.md index be847535..6d8f18b7 100644 --- a/docs/TD_docs/methods/finishFileGeneration.md +++ b/docs/TD_docs/methods/finishFileGeneration.md @@ -14,9 +14,9 @@ Finishes file generation ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|generation\_id|[int64](../constructors/int64.md) | Yes|Identifier of the generation process| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|generation\_id|[int64](../constructors/int64.md) | Identifier of the generation process | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/forwardMessages.md b/docs/TD_docs/methods/forwardMessages.md index cd03624c..a9d35da1 100644 --- a/docs/TD_docs/methods/forwardMessages.md +++ b/docs/TD_docs/methods/forwardMessages.md @@ -14,13 +14,13 @@ Forwards previously sent messages. Returns forwarded messages in the same order ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to forward messages| -|from\_chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to forward from| -|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages to forward| -|disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works if messages are forwarded to secret chat| -|from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of a chat to forward messages | Yes| +|from\_chat\_id|[int53](../types/int53.md) | Identifier of a chat to forward from | Yes| +|message\_ids|Array of [int53](../types/int53.md) | Identifiers of messages to forward | Yes| +|disable\_notification|[Bool](../types/Bool.md) | Pass true, to disable notification about the message, doesn't works if messages are forwarded to secret chat | Yes| +|from\_background|[Bool](../types/Bool.md) | Pass true, if the message is sent from background | Yes| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getArchivedStickerSets.md b/docs/TD_docs/methods/getArchivedStickerSets.md index e4bc954d..0291e6f9 100644 --- a/docs/TD_docs/methods/getArchivedStickerSets.md +++ b/docs/TD_docs/methods/getArchivedStickerSets.md @@ -14,11 +14,11 @@ Returns list of archived sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return mask stickers sets, pass false to return ordinary sticker sets| -|offset\_sticker\_set\_id|[int64](../constructors/int64.md) | Yes|Identifier of the sticker set from which return the result| -|limit|[int](../types/int.md) | Yes|Maximum number of sticker sets to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_masks|[Bool](../types/Bool.md) | Pass true to return mask stickers sets, pass false to return ordinary sticker sets | Yes| +|offset\_sticker\_set\_id|[int64](../constructors/int64.md) | Identifier of the sticker set from which return the result | Yes| +|limit|[int](../types/int.md) | Maximum number of sticker sets to return | Yes| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getAttachedStickerSets.md b/docs/TD_docs/methods/getAttachedStickerSets.md index 50857206..6d75cf9d 100644 --- a/docs/TD_docs/methods/getAttachedStickerSets.md +++ b/docs/TD_docs/methods/getAttachedStickerSets.md @@ -14,9 +14,9 @@ Returns list of sticker sets attached to a file, currently only photos and video ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_id|[int](../types/int.md) | Yes|File identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[int](../types/int.md) | File identifier | Yes| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getBlockedUsers.md b/docs/TD_docs/methods/getBlockedUsers.md index 631ad4c2..bb00089f 100644 --- a/docs/TD_docs/methods/getBlockedUsers.md +++ b/docs/TD_docs/methods/getBlockedUsers.md @@ -14,10 +14,10 @@ Returns users blocked by the current user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Number of users to skip in result, must be non-negative| -|limit|[int](../types/int.md) | Yes|Maximum number of users to return, can't be greater than 100| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Number of users to skip in result, must be non-negative | Yes| +|limit|[int](../types/int.md) | Maximum number of users to return, can't be greater than 100 | Yes| ### Return type: [Users](../types/Users.md) diff --git a/docs/TD_docs/methods/getCallbackQueryAnswer.md b/docs/TD_docs/methods/getCallbackQueryAnswer.md index 1ebcdef1..08fb4a34 100644 --- a/docs/TD_docs/methods/getCallbackQueryAnswer.md +++ b/docs/TD_docs/methods/getCallbackQueryAnswer.md @@ -14,11 +14,11 @@ Sends callback query to a bot and returns answer to it. Returns error with code ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat with a message| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message, from which the query is originated| -|payload|[CallbackQueryPayload](../types/CallbackQueryPayload.md) | Yes|Query payload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat with a message | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message, from which the query is originated | Yes| +|payload|[CallbackQueryPayload](../types/CallbackQueryPayload.md) | Query payload | Yes| ### Return type: [CallbackQueryAnswer](../types/CallbackQueryAnswer.md) diff --git a/docs/TD_docs/methods/getChannel.md b/docs/TD_docs/methods/getChannel.md index 5d97ee91..b08cc7e0 100644 --- a/docs/TD_docs/methods/getChannel.md +++ b/docs/TD_docs/methods/getChannel.md @@ -14,9 +14,9 @@ Returns information about a channel by its identifier, offline request if curren ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Channel identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Channel identifier | Yes| ### Return type: [Channel](../types/Channel.md) diff --git a/docs/TD_docs/methods/getChannelFull.md b/docs/TD_docs/methods/getChannelFull.md index 9986945d..dac4128d 100644 --- a/docs/TD_docs/methods/getChannelFull.md +++ b/docs/TD_docs/methods/getChannelFull.md @@ -14,9 +14,9 @@ Returns full information about a channel by its identifier, cached for at most 1 ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Channel identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Channel identifier | Yes| ### Return type: [ChannelFull](../types/ChannelFull.md) diff --git a/docs/TD_docs/methods/getChannelMembers.md b/docs/TD_docs/methods/getChannelMembers.md index a27a02a0..832f30cd 100644 --- a/docs/TD_docs/methods/getChannelMembers.md +++ b/docs/TD_docs/methods/getChannelMembers.md @@ -14,12 +14,12 @@ Returns information about channel members or banned users. Can be used only if c ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|filter|[ChannelMembersFilter](../types/ChannelMembersFilter.md) | Yes|Kind of channel users to return, defaults to channelMembersRecent| -|offset|[int](../types/int.md) | Yes|Number of channel users to skip| -|limit|[int](../types/int.md) | Yes|Maximum number of users be returned, can't be greater than 200| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|filter|[ChannelMembersFilter](../types/ChannelMembersFilter.md) | Kind of channel users to return, defaults to channelMembersRecent | Yes| +|offset|[int](../types/int.md) | Number of channel users to skip | Yes| +|limit|[int](../types/int.md) | Maximum number of users be returned, can't be greater than 200 | Yes| ### Return type: [ChatMembers](../types/ChatMembers.md) diff --git a/docs/TD_docs/methods/getChat.md b/docs/TD_docs/methods/getChat.md index 58fbea78..37f04e4f 100644 --- a/docs/TD_docs/methods/getChat.md +++ b/docs/TD_docs/methods/getChat.md @@ -14,9 +14,9 @@ Returns information about a chat by its identifier, offline request if current u ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/getChatEventLog.md b/docs/TD_docs/methods/getChatEventLog.md index 3ba1cf0e..bb48a895 100644 --- a/docs/TD_docs/methods/getChatEventLog.md +++ b/docs/TD_docs/methods/getChatEventLog.md @@ -14,14 +14,14 @@ Returns list of service actions taken by chat members and administrators in the ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|query|[string](../types/string.md) | Yes|Search query to filter events| -|from\_event\_id|[int64](../constructors/int64.md) | Yes|Identifier of an event from which to return result, you can use 0 to get results from the latest events| -|limit|[int](../types/int.md) | Yes|Maximum number of events to return, can't be greater than 100| -|filters|[chatEventLogFilters](../constructors/chatEventLogFilters.md) | Yes|Types of events to return, defaults to all| -|user\_ids|Array of [int](../types/int.md) | Yes|User identifiers, which events to return, defaults to all users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|query|[string](../types/string.md) | Search query to filter events | Yes| +|from\_event\_id|[int64](../constructors/int64.md) | Identifier of an event from which to return result, you can use 0 to get results from the latest events | Yes| +|limit|[int](../types/int.md) | Maximum number of events to return, can't be greater than 100 | Yes| +|filters|[chatEventLogFilters](../constructors/chatEventLogFilters.md) | Types of events to return, defaults to all | Yes| +|user\_ids|Array of [int](../types/int.md) | User identifiers, which events to return, defaults to all users | Yes| ### Return type: [ChatEvents](../types/ChatEvents.md) diff --git a/docs/TD_docs/methods/getChatHistory.md b/docs/TD_docs/methods/getChatHistory.md index 1c6fd4b8..66b8e4b1 100644 --- a/docs/TD_docs/methods/getChatHistory.md +++ b/docs/TD_docs/methods/getChatHistory.md @@ -14,13 +14,13 @@ Returns messages in a chat. Returns result in reverse chronological order, i.e. ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest| -|offset|[int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| -|only\_local|[Bool](../types/Bool.md) | Yes|Return only locally available messages without sending network requests| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|from\_message\_id|[int53](../types/int53.md) | Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest | Yes| +|offset|[int](../types/int.md) | Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages | Yes| +|limit|[int](../types/int.md) | Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached | Yes| +|only\_local|[Bool](../types/Bool.md) | Return only locally available messages without sending network requests | Yes| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getChatMember.md b/docs/TD_docs/methods/getChatMember.md index 89dc2e9f..2d2e65ce 100644 --- a/docs/TD_docs/methods/getChatMember.md +++ b/docs/TD_docs/methods/getChatMember.md @@ -14,10 +14,10 @@ Returns information about one participant of the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [ChatMember](../types/ChatMember.md) diff --git a/docs/TD_docs/methods/getChatReportSpamState.md b/docs/TD_docs/methods/getChatReportSpamState.md index e817f284..f0385800 100644 --- a/docs/TD_docs/methods/getChatReportSpamState.md +++ b/docs/TD_docs/methods/getChatReportSpamState.md @@ -14,9 +14,9 @@ Returns current chat report spam state ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [ChatReportSpamState](../types/ChatReportSpamState.md) diff --git a/docs/TD_docs/methods/getChats.md b/docs/TD_docs/methods/getChats.md index 0c04d59e..ff201e09 100644 --- a/docs/TD_docs/methods/getChats.md +++ b/docs/TD_docs/methods/getChats.md @@ -14,11 +14,11 @@ Returns list of chats in the right order, chats are sorted by (order, chat_id) i ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_order|[int64](../constructors/int64.md) | Yes|Chat order to return chats from| -|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to return chats from| -|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned. There may be less than limit chats returned even the end of the list is not reached| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_order|[int64](../constructors/int64.md) | Chat order to return chats from | Yes| +|offset\_chat\_id|[int53](../types/int53.md) | Chat identifier to return chats from | Yes| +|limit|[int](../types/int.md) | Maximum number of chats to be returned. There may be less than limit chats returned even the end of the list is not reached | Yes| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getCommonChats.md b/docs/TD_docs/methods/getCommonChats.md index 194fd7d5..de0fdd4a 100644 --- a/docs/TD_docs/methods/getCommonChats.md +++ b/docs/TD_docs/methods/getCommonChats.md @@ -14,11 +14,11 @@ Returns list of common chats with an other given user. Chats are sorted by their ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| -|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to return chats from, use 0 for the first request| -|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned, up to 100| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| +|offset\_chat\_id|[int53](../types/int53.md) | Chat identifier to return chats from, use 0 for the first request | Yes| +|limit|[int](../types/int.md) | Maximum number of chats to be returned, up to 100 | Yes| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getFile.md b/docs/TD_docs/methods/getFile.md index 0dc7efee..b981592c 100644 --- a/docs/TD_docs/methods/getFile.md +++ b/docs/TD_docs/methods/getFile.md @@ -14,9 +14,9 @@ Returns information about a file, offline request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_id|[int](../types/int.md) | Yes|Identifier of the file to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_id|[int](../types/int.md) | Identifier of the file to get | Yes| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/getFileExtension.md b/docs/TD_docs/methods/getFileExtension.md index abb55864..8600668d 100644 --- a/docs/TD_docs/methods/getFileExtension.md +++ b/docs/TD_docs/methods/getFileExtension.md @@ -14,9 +14,9 @@ Returns file's extension guessing only by its mime type. Returns empty string on ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|mime\_type|[string](../types/string.md) | Yes|Mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|mime\_type|[string](../types/string.md) | Mime type of the file | Yes| ### Return type: [Text](../types/Text.md) diff --git a/docs/TD_docs/methods/getFileMimeType.md b/docs/TD_docs/methods/getFileMimeType.md index bc2695a9..444dd236 100644 --- a/docs/TD_docs/methods/getFileMimeType.md +++ b/docs/TD_docs/methods/getFileMimeType.md @@ -14,9 +14,9 @@ Returns file's mime type guessing only by its extension. Returns empty string on ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file\_name|[string](../types/string.md) | Yes|Name of the file or path to the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file\_name|[string](../types/string.md) | Name of the file or path to the file | Yes| ### Return type: [Text](../types/Text.md) diff --git a/docs/TD_docs/methods/getFilePersistent.md b/docs/TD_docs/methods/getFilePersistent.md index d5b694ca..4fbf0802 100644 --- a/docs/TD_docs/methods/getFilePersistent.md +++ b/docs/TD_docs/methods/getFilePersistent.md @@ -14,10 +14,10 @@ Returns information about a file by its persistent id, offline request. May be u ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|persistent\_file\_id|[string](../types/string.md) | Yes|Persistent identifier of the file to get| -|file\_type|[FileType](../types/FileType.md) | Yes|File type, if known| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|persistent\_file\_id|[string](../types/string.md) | Persistent identifier of the file to get | Yes| +|file\_type|[FileType](../types/FileType.md) | File type, if known | Yes| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/getGameHighScores.md b/docs/TD_docs/methods/getGameHighScores.md index badbdfde..a28d31bf 100644 --- a/docs/TD_docs/methods/getGameHighScores.md +++ b/docs/TD_docs/methods/getGameHighScores.md @@ -14,11 +14,11 @@ Bots only. Returns game high scores and some part of the score table around of t ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat a message with the game belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| -|user\_id|[int](../types/int.md) | Yes|User identifie| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat a message with the game belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message | Yes| +|user\_id|[int](../types/int.md) | User identifie | Yes| ### Return type: [GameHighScores](../types/GameHighScores.md) diff --git a/docs/TD_docs/methods/getGroup.md b/docs/TD_docs/methods/getGroup.md index b6f4a70c..f17011b8 100644 --- a/docs/TD_docs/methods/getGroup.md +++ b/docs/TD_docs/methods/getGroup.md @@ -14,9 +14,9 @@ Returns information about a group by its identifier, offline request if current ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|group\_id|[int](../types/int.md) | Yes|Group identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|group\_id|[int](../types/int.md) | Group identifier | Yes| ### Return type: [Group](../types/Group.md) diff --git a/docs/TD_docs/methods/getGroupFull.md b/docs/TD_docs/methods/getGroupFull.md index 086965fb..c7269406 100644 --- a/docs/TD_docs/methods/getGroupFull.md +++ b/docs/TD_docs/methods/getGroupFull.md @@ -14,9 +14,9 @@ Returns full information about a group by its identifier ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|group\_id|[int](../types/int.md) | Yes|Group identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|group\_id|[int](../types/int.md) | Group identifier | Yes| ### Return type: [GroupFull](../types/GroupFull.md) diff --git a/docs/TD_docs/methods/getInlineGameHighScores.md b/docs/TD_docs/methods/getInlineGameHighScores.md index fffeb273..9deeb118 100644 --- a/docs/TD_docs/methods/getInlineGameHighScores.md +++ b/docs/TD_docs/methods/getInlineGameHighScores.md @@ -14,10 +14,10 @@ Bots only. Returns game high scores and some part of the score table around of t ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|inline\_message\_id|[string](../types/string.md) | Inline message identifier | Yes| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [GameHighScores](../types/GameHighScores.md) diff --git a/docs/TD_docs/methods/getInlineQueryResults.md b/docs/TD_docs/methods/getInlineQueryResults.md index 85aae1f2..6fb6691d 100644 --- a/docs/TD_docs/methods/getInlineQueryResults.md +++ b/docs/TD_docs/methods/getInlineQueryResults.md @@ -14,13 +14,13 @@ Sends inline query to a bot and returns its results. Returns error with code 502 ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot\_user\_id|[int](../types/int.md) | Yes|Identifier of the bot send query to| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, where the query is sent| -|user\_location|[location](../constructors/location.md) | Yes|User location, only if needed| -|query|[string](../types/string.md) | Yes|Text of the query| -|offset|[string](../types/string.md) | Yes|Offset of the first entry to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot\_user\_id|[int](../types/int.md) | Identifier of the bot send query to | Yes| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat, where the query is sent | Yes| +|user\_location|[location](../constructors/location.md) | User location, only if needed | Yes| +|query|[string](../types/string.md) | Text of the query | Yes| +|offset|[string](../types/string.md) | Offset of the first entry to return | Yes| ### Return type: [InlineQueryResults](../types/InlineQueryResults.md) diff --git a/docs/TD_docs/methods/getInstalledStickerSets.md b/docs/TD_docs/methods/getInstalledStickerSets.md index 1fa4627f..0b140ea2 100644 --- a/docs/TD_docs/methods/getInstalledStickerSets.md +++ b/docs/TD_docs/methods/getInstalledStickerSets.md @@ -14,9 +14,9 @@ Returns list of installed sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to return mask sticker sets, pass false to return ordinary sticker sets| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_masks|[Bool](../types/Bool.md) | Pass true to return mask sticker sets, pass false to return ordinary sticker sets | Yes| ### Return type: [StickerSets](../types/StickerSets.md) diff --git a/docs/TD_docs/methods/getMessage.md b/docs/TD_docs/methods/getMessage.md index a2386ea9..0d242a32 100644 --- a/docs/TD_docs/methods/getMessage.md +++ b/docs/TD_docs/methods/getMessage.md @@ -14,10 +14,10 @@ Returns information about a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, message belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat, message belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message to get | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/getMessages.md b/docs/TD_docs/methods/getMessages.md index d678cdf8..76bd4c7e 100644 --- a/docs/TD_docs/methods/getMessages.md +++ b/docs/TD_docs/methods/getMessages.md @@ -14,10 +14,10 @@ Returns information about messages. If message is not found, returns null on the ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, messages belongs to| -|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of the messages to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat, messages belongs to | Yes| +|message\_ids|Array of [int53](../types/int53.md) | Identifiers of the messages to get | Yes| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/getNetworkStatistics.md b/docs/TD_docs/methods/getNetworkStatistics.md index fc8acab3..aa14ed25 100644 --- a/docs/TD_docs/methods/getNetworkStatistics.md +++ b/docs/TD_docs/methods/getNetworkStatistics.md @@ -14,9 +14,9 @@ Returns network data usage statistics. Can be called before authorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|only\_current|[Bool](../types/Bool.md) | Yes|If true, returns only data for the current library launch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|only\_current|[Bool](../types/Bool.md) | If true, returns only data for the current library launch | Yes| ### Return type: [NetworkStatistics](../types/NetworkStatistics.md) diff --git a/docs/TD_docs/methods/getNotificationSettings.md b/docs/TD_docs/methods/getNotificationSettings.md index a99d1627..22988865 100644 --- a/docs/TD_docs/methods/getNotificationSettings.md +++ b/docs/TD_docs/methods/getNotificationSettings.md @@ -14,9 +14,9 @@ Returns notification settings for a given scope ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|scope|[NotificationSettingsScope](../types/NotificationSettingsScope.md) | Yes|Scope to return information about notification settings| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|scope|[NotificationSettingsScope](../types/NotificationSettingsScope.md) | Scope to return information about notification settings | Yes| ### Return type: [NotificationSettings](../types/NotificationSettings.md) diff --git a/docs/TD_docs/methods/getOption.md b/docs/TD_docs/methods/getOption.md index 440c6ecd..0dc8e190 100644 --- a/docs/TD_docs/methods/getOption.md +++ b/docs/TD_docs/methods/getOption.md @@ -14,9 +14,9 @@ Returns value of an option by its name. See list of available options on https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|name|[string](../types/string.md) | Yes|Name of the option| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|name|[string](../types/string.md) | Name of the option | Yes| ### Return type: [OptionValue](../types/OptionValue.md) diff --git a/docs/TD_docs/methods/getPaymentForm.md b/docs/TD_docs/methods/getPaymentForm.md index 36b8160c..7f6c205c 100644 --- a/docs/TD_docs/methods/getPaymentForm.md +++ b/docs/TD_docs/methods/getPaymentForm.md @@ -14,10 +14,10 @@ Returns invoice payment form. The method should be called when user presses inli ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| -|message\_id|[int53](../types/int53.md) | Yes|Message identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier of the Invoice message | Yes| +|message\_id|[int53](../types/int53.md) | Message identifier | Yes| ### Return type: [PaymentForm](../types/PaymentForm.md) diff --git a/docs/TD_docs/methods/getPaymentReceipt.md b/docs/TD_docs/methods/getPaymentReceipt.md index c4da14d1..12669e61 100644 --- a/docs/TD_docs/methods/getPaymentReceipt.md +++ b/docs/TD_docs/methods/getPaymentReceipt.md @@ -14,10 +14,10 @@ Returns information about successful payment ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the PaymentSuccessful message| -|message\_id|[int53](../types/int53.md) | Yes|Message identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier of the PaymentSuccessful message | Yes| +|message\_id|[int53](../types/int53.md) | Message identifier | Yes| ### Return type: [PaymentReceipt](../types/PaymentReceipt.md) diff --git a/docs/TD_docs/methods/getPrivacy.md b/docs/TD_docs/methods/getPrivacy.md index f7dfda60..92392b62 100644 --- a/docs/TD_docs/methods/getPrivacy.md +++ b/docs/TD_docs/methods/getPrivacy.md @@ -14,9 +14,9 @@ Returns current privacy settings ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|key|[PrivacyKey](../types/PrivacyKey.md) | Yes|Privacy key| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|key|[PrivacyKey](../types/PrivacyKey.md) | Privacy key | Yes| ### Return type: [PrivacyRules](../types/PrivacyRules.md) diff --git a/docs/TD_docs/methods/getPublicMessageLink.md b/docs/TD_docs/methods/getPublicMessageLink.md index 7248cef5..d0513d5a 100644 --- a/docs/TD_docs/methods/getPublicMessageLink.md +++ b/docs/TD_docs/methods/getPublicMessageLink.md @@ -14,10 +14,10 @@ Returns public HTTPS link to a message. Available only for messages in public ch ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat, message belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat, message belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message | Yes| ### Return type: [PublicMessageLink](../types/PublicMessageLink.md) diff --git a/docs/TD_docs/methods/getRecentStickers.md b/docs/TD_docs/methods/getRecentStickers.md index 1a8b05b1..98c1dad3 100644 --- a/docs/TD_docs/methods/getRecentStickers.md +++ b/docs/TD_docs/methods/getRecentStickers.md @@ -14,9 +14,9 @@ Returns list of recently used stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_attached|[Bool](../types/Bool.md) | Yes|Pass true to return stickers and masks recently attached to photo or video files, pass false to return recently sent stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_attached|[Bool](../types/Bool.md) | Pass true to return stickers and masks recently attached to photo or video files, pass false to return recently sent stickers | Yes| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/getRecoveryEmail.md b/docs/TD_docs/methods/getRecoveryEmail.md index 97c5003a..285ccb1a 100644 --- a/docs/TD_docs/methods/getRecoveryEmail.md +++ b/docs/TD_docs/methods/getRecoveryEmail.md @@ -14,9 +14,9 @@ Returns set up recovery email. This method can be used to verify a password prov ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|password|[string](../types/string.md) | Yes|Current user password| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[string](../types/string.md) | Current user password | Yes| ### Return type: [RecoveryEmail](../types/RecoveryEmail.md) diff --git a/docs/TD_docs/methods/getSecretChat.md b/docs/TD_docs/methods/getSecretChat.md index 99bad593..e326135f 100644 --- a/docs/TD_docs/methods/getSecretChat.md +++ b/docs/TD_docs/methods/getSecretChat.md @@ -14,9 +14,9 @@ Returns information about a secret chat by its identifier, offline request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|secret\_chat\_id|[int](../types/int.md) | Yes|Secret chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|secret\_chat\_id|[int](../types/int.md) | Secret chat identifier | Yes| ### Return type: [SecretChat](../types/SecretChat.md) diff --git a/docs/TD_docs/methods/getStickerEmojis.md b/docs/TD_docs/methods/getStickerEmojis.md index 42157c1e..72304f50 100644 --- a/docs/TD_docs/methods/getStickerEmojis.md +++ b/docs/TD_docs/methods/getStickerEmojis.md @@ -14,9 +14,9 @@ Returns emojis corresponding to a sticker ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[InputFile](../types/InputFile.md) | Yes|Sticker file identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[InputFile](../types/InputFile.md) | Sticker file identifier | Yes| ### Return type: [StickerEmojis](../types/StickerEmojis.md) diff --git a/docs/TD_docs/methods/getStickerSet.md b/docs/TD_docs/methods/getStickerSet.md index a7747e8e..dcbfc830 100644 --- a/docs/TD_docs/methods/getStickerSet.md +++ b/docs/TD_docs/methods/getStickerSet.md @@ -14,9 +14,9 @@ Returns information about sticker set by its identifier ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|set\_id|[int64](../constructors/int64.md) | Yes|Identifier of the sticker set| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|set\_id|[int64](../constructors/int64.md) | Identifier of the sticker set | Yes| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/getStickers.md b/docs/TD_docs/methods/getStickers.md index c63096ad..3aadef87 100644 --- a/docs/TD_docs/methods/getStickers.md +++ b/docs/TD_docs/methods/getStickers.md @@ -14,10 +14,10 @@ Returns stickers from installed ordinary sticker sets corresponding to the given ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoji|[string](../types/string.md) | Yes|String representation of emoji. If empty, returns all known stickers| -|limit|[int](../types/int.md) | Yes|Maximum number of stickers to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoji|[string](../types/string.md) | String representation of emoji. If empty, returns all known stickers | Yes| +|limit|[int](../types/int.md) | Maximum number of stickers to return | Yes| ### Return type: [Stickers](../types/Stickers.md) diff --git a/docs/TD_docs/methods/getStorageStatistics.md b/docs/TD_docs/methods/getStorageStatistics.md index dfdb300f..b164504f 100644 --- a/docs/TD_docs/methods/getStorageStatistics.md +++ b/docs/TD_docs/methods/getStorageStatistics.md @@ -14,9 +14,9 @@ Returns storage usage statistics ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_limit|[int](../types/int.md) | Yes|Maximum number of chats with biggest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If chat info database is not used, chat_limit is ignored and is always set to 0| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_limit|[int](../types/int.md) | Maximum number of chats with biggest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If chat info database is not used, chat_limit is ignored and is always set to 0 | Yes| ### Return type: [StorageStatistics](../types/StorageStatistics.md) diff --git a/docs/TD_docs/methods/getTextEntities.md b/docs/TD_docs/methods/getTextEntities.md index 6ce41dcc..171f29c7 100644 --- a/docs/TD_docs/methods/getTextEntities.md +++ b/docs/TD_docs/methods/getTextEntities.md @@ -14,9 +14,9 @@ Returns all mentions, hashtags, bot commands, URLs and emails contained in the t ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|text|[string](../types/string.md) | Yes|Text to find entites in| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|text|[string](../types/string.md) | Text to find entites in | Yes| ### Return type: [TextEntities](../types/TextEntities.md) diff --git a/docs/TD_docs/methods/getTopChats.md b/docs/TD_docs/methods/getTopChats.md index 55d7b4af..41a1e6a8 100644 --- a/docs/TD_docs/methods/getTopChats.md +++ b/docs/TD_docs/methods/getTopChats.md @@ -14,10 +14,10 @@ Returns a list of frequently used chats. Supported only if chat info database is ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|category|[TopChatCategory](../types/TopChatCategory.md) | Yes|Category of chats to return| -|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned, at most 30| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|category|[TopChatCategory](../types/TopChatCategory.md) | Category of chats to return | Yes| +|limit|[int](../types/int.md) | Maximum number of chats to be returned, at most 30 | Yes| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/getUser.md b/docs/TD_docs/methods/getUser.md index f8f0f45d..e263058b 100644 --- a/docs/TD_docs/methods/getUser.md +++ b/docs/TD_docs/methods/getUser.md @@ -14,9 +14,9 @@ Returns information about a user by its identifier, offline request if current u ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [User](../types/User.md) diff --git a/docs/TD_docs/methods/getUserFull.md b/docs/TD_docs/methods/getUserFull.md index 1ed56e8d..7e6acdc5 100644 --- a/docs/TD_docs/methods/getUserFull.md +++ b/docs/TD_docs/methods/getUserFull.md @@ -14,9 +14,9 @@ Returns full information about a user by its identifier ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [UserFull](../types/UserFull.md) diff --git a/docs/TD_docs/methods/getUserProfilePhotos.md b/docs/TD_docs/methods/getUserProfilePhotos.md index 41784c90..43c39ae6 100644 --- a/docs/TD_docs/methods/getUserProfilePhotos.md +++ b/docs/TD_docs/methods/getUserProfilePhotos.md @@ -14,11 +14,11 @@ Returns profile photos of the user. Result of this query may be outdated: some p ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| -|offset|[int](../types/int.md) | Yes|Photos to skip, must be non-negative| -|limit|[int](../types/int.md) | Yes|Maximum number of photos to be returned, can't be greater than 100| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| +|offset|[int](../types/int.md) | Photos to skip, must be non-negative | Yes| +|limit|[int](../types/int.md) | Maximum number of photos to be returned, can't be greater than 100 | Yes| ### Return type: [UserProfilePhotos](../types/UserProfilePhotos.md) diff --git a/docs/TD_docs/methods/getWebPageInstantView.md b/docs/TD_docs/methods/getWebPageInstantView.md index de0f33fe..50e97403 100644 --- a/docs/TD_docs/methods/getWebPageInstantView.md +++ b/docs/TD_docs/methods/getWebPageInstantView.md @@ -14,10 +14,10 @@ Returns web page instant view if available. Returns error 404 if web page has no ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|Web page URL| -|force\_full|[Bool](../types/Bool.md) | Yes|If true, full web page instant view will be returned| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | Web page URL | Yes| +|force\_full|[Bool](../types/Bool.md) | If true, full web page instant view will be returned | Yes| ### Return type: [WebPageInstantView](../types/WebPageInstantView.md) diff --git a/docs/TD_docs/methods/getWebPagePreview.md b/docs/TD_docs/methods/getWebPagePreview.md index b6ce4d01..2f063476 100644 --- a/docs/TD_docs/methods/getWebPagePreview.md +++ b/docs/TD_docs/methods/getWebPagePreview.md @@ -14,9 +14,9 @@ Returns web page preview by text of the message. Do not call this function to of ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message\_text|[string](../types/string.md) | Yes|Message text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message\_text|[string](../types/string.md) | Message text | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/docs/TD_docs/methods/importChatInviteLink.md b/docs/TD_docs/methods/importChatInviteLink.md index db9777c0..ebb52f44 100644 --- a/docs/TD_docs/methods/importChatInviteLink.md +++ b/docs/TD_docs/methods/importChatInviteLink.md @@ -14,9 +14,9 @@ Imports chat invite link, adds current user to a chat if possible. Member will n ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|invite\_link|[string](../types/string.md) | Yes|Invite link to import. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/"| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|invite\_link|[string](../types/string.md) | Invite link to import. Should begin with "https: t.me/joinchat/", "https: telegram.me/joinchat/" or "https: telegram.dog/joinchat/" | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/importContacts.md b/docs/TD_docs/methods/importContacts.md index 0903e1db..705406ff 100644 --- a/docs/TD_docs/methods/importContacts.md +++ b/docs/TD_docs/methods/importContacts.md @@ -14,9 +14,9 @@ Adds new contacts/edits existing contacts, contacts user identifiers are ignored ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [contact](../constructors/contact.md) | Yes|List of contacts to import/edit| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [contact](../constructors/contact.md) | List of contacts to import/edit | Yes| ### Return type: [ImportedContacts](../types/ImportedContacts.md) diff --git a/docs/TD_docs/methods/migrateGroupChatToChannelChat.md b/docs/TD_docs/methods/migrateGroupChatToChannelChat.md index 81f39e0b..cdfc5e24 100644 --- a/docs/TD_docs/methods/migrateGroupChatToChannelChat.md +++ b/docs/TD_docs/methods/migrateGroupChatToChannelChat.md @@ -14,9 +14,9 @@ Creates new channel supergroup chat from existing group chat and send correspond ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Group chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Group chat identifier | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/openChat.md b/docs/TD_docs/methods/openChat.md index 654f5c8e..dfbdbad2 100644 --- a/docs/TD_docs/methods/openChat.md +++ b/docs/TD_docs/methods/openChat.md @@ -14,9 +14,9 @@ Chat is opened by the user. Many useful activities depends on chat being opened ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/openMessageContent.md b/docs/TD_docs/methods/openMessageContent.md index beabbaf7..2ef75d51 100644 --- a/docs/TD_docs/methods/openMessageContent.md +++ b/docs/TD_docs/methods/openMessageContent.md @@ -14,10 +14,10 @@ Message content is opened, for example the user has opened a photo, a video, a d ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the message| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message with opened content| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier of the message | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message with opened content | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/optimizeStorage.md b/docs/TD_docs/methods/optimizeStorage.md index b38b0b8e..4ee58c8d 100644 --- a/docs/TD_docs/methods/optimizeStorage.md +++ b/docs/TD_docs/methods/optimizeStorage.md @@ -14,16 +14,16 @@ Optimizes storage usage, i.e. deletes some files and return new storage usage st ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|size|[int53](../types/int53.md) | Yes|Limit on total size of files after deletion. Pass -1 to use default limit| -|ttl|[int](../types/int.md) | Yes|Limit on time passed since last access time (or creation time on some filesystems) to a file. Pass -1 to use default limit| -|count|[int](../types/int.md) | Yes|Limit on total count of files after deletion. Pass -1 to use default limit| -|immunity\_delay|[int](../types/int.md) | Yes|Number of seconds after creation of a file, it can't be delited. Pass -1 to use default value| -|file\_types|Array of [FileType](../types/FileType.md) | Yes|If not empty, only files with given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted| -|chat\_ids|Array of [int53](../types/int53.md) | Yes|If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat, for example profile photos| -|exclude\_chat\_ids|Array of [int53](../types/int53.md) | Yes|If not empty, files from the given chats are exluded. Use 0 as chat identifier to exclude all files not belonging to any chat, for example profile photos| -|chat\_limit|[int](../types/int.md) | Yes|Same as in getStorageStatistics. Affects only returned statistics| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|size|[int53](../types/int53.md) | Limit on total size of files after deletion. Pass -1 to use default limit | Yes| +|ttl|[int](../types/int.md) | Limit on time passed since last access time (or creation time on some filesystems) to a file. Pass -1 to use default limit | Yes| +|count|[int](../types/int.md) | Limit on total count of files after deletion. Pass -1 to use default limit | Yes| +|immunity\_delay|[int](../types/int.md) | Number of seconds after creation of a file, it can't be delited. Pass -1 to use default value | Yes| +|file\_types|Array of [FileType](../types/FileType.md) | If not empty, only files with given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted | Yes| +|chat\_ids|Array of [int53](../types/int53.md) | If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat, for example profile photos | Yes| +|exclude\_chat\_ids|Array of [int53](../types/int53.md) | If not empty, files from the given chats are exluded. Use 0 as chat identifier to exclude all files not belonging to any chat, for example profile photos | Yes| +|chat\_limit|[int](../types/int.md) | Same as in getStorageStatistics. Affects only returned statistics | Yes| ### Return type: [StorageStatistics](../types/StorageStatistics.md) diff --git a/docs/TD_docs/methods/pinChannelMessage.md b/docs/TD_docs/methods/pinChannelMessage.md index 2f3cbcbb..e8f84325 100644 --- a/docs/TD_docs/methods/pinChannelMessage.md +++ b/docs/TD_docs/methods/pinChannelMessage.md @@ -14,11 +14,11 @@ Pins a message in a supergroup channel chat. Needs appropriate rights in the cha ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the new pinned message| -|disable\_notification|[Bool](../types/Bool.md) | Yes|True, if there should be no notification about the pinned message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the new pinned message | Yes| +|disable\_notification|[Bool](../types/Bool.md) | True, if there should be no notification about the pinned message | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/processDcUpdate.md b/docs/TD_docs/methods/processDcUpdate.md index 4494b2e5..023b5a0d 100644 --- a/docs/TD_docs/methods/processDcUpdate.md +++ b/docs/TD_docs/methods/processDcUpdate.md @@ -14,10 +14,10 @@ Handles DC_UPDATE push service notification. Can be called before authorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|dc|[string](../types/string.md) | Yes|Value of 'dc' paramater of the notification| -|addr|[string](../types/string.md) | Yes|Value of 'addr' parameter of the notification| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|dc|[string](../types/string.md) | Value of 'dc' paramater of the notification | Yes| +|addr|[string](../types/string.md) | Value of 'addr' parameter of the notification | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/rateCall.md b/docs/TD_docs/methods/rateCall.md index 73a555df..430fcf73 100644 --- a/docs/TD_docs/methods/rateCall.md +++ b/docs/TD_docs/methods/rateCall.md @@ -14,11 +14,11 @@ Sends call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|call\_id|[int](../types/int.md) | Yes|Call identifier| -|rating|[int](../types/int.md) | Yes|Call rating, 1-5| -|comment|[string](../types/string.md) | Yes|Optional user comment if rating is less than 5| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|call\_id|[int](../types/int.md) | Call identifier | Yes| +|rating|[int](../types/int.md) | Call rating, 1-5 | Yes| +|comment|[string](../types/string.md) | Optional user comment if rating is less than 5 | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/recoverAuthPassword.md b/docs/TD_docs/methods/recoverAuthPassword.md index 4f51208a..21f40fe1 100644 --- a/docs/TD_docs/methods/recoverAuthPassword.md +++ b/docs/TD_docs/methods/recoverAuthPassword.md @@ -14,9 +14,9 @@ Recovers password with recovery code sent to email. Works only when getAuthState ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|recovery\_code|[string](../types/string.md) | Yes|Recovery code to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|recovery\_code|[string](../types/string.md) | Recovery code to check | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/recoverPassword.md b/docs/TD_docs/methods/recoverPassword.md index bc674d04..d3f9e7eb 100644 --- a/docs/TD_docs/methods/recoverPassword.md +++ b/docs/TD_docs/methods/recoverPassword.md @@ -14,9 +14,9 @@ Recovers password with recovery code sent to email ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|recovery\_code|[string](../types/string.md) | Yes|Recovery code to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|recovery\_code|[string](../types/string.md) | Recovery code to check | Yes| ### Return type: [PasswordState](../types/PasswordState.md) diff --git a/docs/TD_docs/methods/registerDevice.md b/docs/TD_docs/methods/registerDevice.md index 97cd8a80..706751f9 100644 --- a/docs/TD_docs/methods/registerDevice.md +++ b/docs/TD_docs/methods/registerDevice.md @@ -14,9 +14,9 @@ Registers current used device for receiving push notifications ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|device\_token|[DeviceToken](../types/DeviceToken.md) | Yes|Device token| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|device\_token|[DeviceToken](../types/DeviceToken.md) | Device token | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reorderInstalledStickerSets.md b/docs/TD_docs/methods/reorderInstalledStickerSets.md index 46f5573a..7693dc62 100644 --- a/docs/TD_docs/methods/reorderInstalledStickerSets.md +++ b/docs/TD_docs/methods/reorderInstalledStickerSets.md @@ -14,10 +14,10 @@ Changes the order of installed sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|is\_masks|[Bool](../types/Bool.md) | Yes|Pass true to change mask sticker sets order, pass false to change ordinary sticker sets order| -|sticker\_set\_ids|Array of [int64](../constructors/int64.md) | Yes|Identifiers of installed sticker sets in the new right order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|is\_masks|[Bool](../types/Bool.md) | Pass true to change mask sticker sets order, pass false to change ordinary sticker sets order | Yes| +|sticker\_set\_ids|Array of [int64](../constructors/int64.md) | Identifiers of installed sticker sets in the new right order | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reportChannelSpam.md b/docs/TD_docs/methods/reportChannelSpam.md index 40ad933e..457587c7 100644 --- a/docs/TD_docs/methods/reportChannelSpam.md +++ b/docs/TD_docs/methods/reportChannelSpam.md @@ -14,11 +14,11 @@ Reports some supergroup channel messages from a user as spam messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Channel identifier| -|user\_id|[int](../types/int.md) | Yes|User identifier| -|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of messages sent in the supergroup by the user, the list should be non-empty| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Channel identifier | Yes| +|user\_id|[int](../types/int.md) | User identifier | Yes| +|message\_ids|Array of [int53](../types/int53.md) | Identifiers of messages sent in the supergroup by the user, the list should be non-empty | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/reportChat.md b/docs/TD_docs/methods/reportChat.md index 843cc2f4..4d73dad8 100644 --- a/docs/TD_docs/methods/reportChat.md +++ b/docs/TD_docs/methods/reportChat.md @@ -14,10 +14,10 @@ Reports chat to Telegram moderators. Can be used only for a channel chat or a pr ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|reason|[ChatReportReason](../types/ChatReportReason.md) | Yes|Reason, the chat is reported| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|reason|[ChatReportReason](../types/ChatReportReason.md) | Reason, the chat is reported | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/resetAuth.md b/docs/TD_docs/methods/resetAuth.md index cec0d070..592acd1a 100644 --- a/docs/TD_docs/methods/resetAuth.md +++ b/docs/TD_docs/methods/resetAuth.md @@ -14,9 +14,9 @@ Logs out user. If force == false, begins to perform soft log out, returns authSt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Yes|If true, just delete all local data. Session will remain in list of active sessions| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | If true, just delete all local data. Session will remain in list of active sessions | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/searchCallMessages.md b/docs/TD_docs/methods/searchCallMessages.md index ebeae488..782da500 100644 --- a/docs/TD_docs/methods/searchCallMessages.md +++ b/docs/TD_docs/methods/searchCallMessages.md @@ -14,11 +14,11 @@ Searches for call messages. Returns result in reverse chronological order, i. e. ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which to search, you can use 0 to get results from beginning| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached filter| -|only\_missed|[Bool](../types/Bool.md) | Yes|If true, return only messages with missed calls| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|from\_message\_id|[int53](../types/int53.md) | Identifier of the message from which to search, you can use 0 to get results from beginning | Yes| +|limit|[int](../types/int.md) | Maximum number of messages to be returned, can't be greater than 100. There may be less than limit messages returned even the end of the history is not reached filter | Yes| +|only\_missed|[Bool](../types/Bool.md) | If true, return only messages with missed calls | Yes| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchChatMembers.md b/docs/TD_docs/methods/searchChatMembers.md index aebf7e65..f0f3e0f1 100644 --- a/docs/TD_docs/methods/searchChatMembers.md +++ b/docs/TD_docs/methods/searchChatMembers.md @@ -14,11 +14,11 @@ Searches for the specified query in the first name, last name and username among ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|query|[string](../types/string.md) | Yes|Query to search for| -|limit|[int](../types/int.md) | Yes|Maximum number of users to be returned| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|query|[string](../types/string.md) | Query to search for | Yes| +|limit|[int](../types/int.md) | Maximum number of users to be returned | Yes| ### Return type: [ChatMembers](../types/ChatMembers.md) diff --git a/docs/TD_docs/methods/searchChatMessages.md b/docs/TD_docs/methods/searchChatMessages.md index 63a130a3..6e18472b 100644 --- a/docs/TD_docs/methods/searchChatMessages.md +++ b/docs/TD_docs/methods/searchChatMessages.md @@ -14,15 +14,15 @@ Searches for messages with given words in the chat. Returns result in reverse ch ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier to search messages in| -|query|[string](../types/string.md) | Yes|Query to search for| -|sender\_user\_id|[int](../types/int.md) | Yes|If not 0, only messages sent by the specified user will be returned. Doesn't supported in secret chats| -|from\_message\_id|[int53](../types/int53.md) | Yes|Identifier of the message from which we need a history, you can use 0 to get results from the beginning| -|offset|[int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached| -|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Optional|Filter for content of the searched messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier to search messages in | Yes| +|query|[string](../types/string.md) | Query to search for | Yes| +|sender\_user\_id|[int](../types/int.md) | If not 0, only messages sent by the specified user will be returned. Doesn't supported in secret chats | Yes| +|from\_message\_id|[int53](../types/int53.md) | Identifier of the message from which we need a history, you can use 0 to get results from the beginning | Yes| +|offset|[int](../types/int.md) | Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages | Yes| +|limit|[int](../types/int.md) | Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached | Yes| +|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Filter for content of the searched messages | Optional| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchChats.md b/docs/TD_docs/methods/searchChats.md index 2793bdef..a17f0b24 100644 --- a/docs/TD_docs/methods/searchChats.md +++ b/docs/TD_docs/methods/searchChats.md @@ -14,10 +14,10 @@ Searches for specified query in the title and username of known chats, offline r ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query|[string](../types/string.md) | Yes|Query to search for, if query is empty, returns up to 20 recently found chats| -|limit|[int](../types/int.md) | Yes|Maximum number of chats to be returned| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query|[string](../types/string.md) | Query to search for, if query is empty, returns up to 20 recently found chats | Yes| +|limit|[int](../types/int.md) | Maximum number of chats to be returned | Yes| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/searchContacts.md b/docs/TD_docs/methods/searchContacts.md index c95decaf..665414c2 100644 --- a/docs/TD_docs/methods/searchContacts.md +++ b/docs/TD_docs/methods/searchContacts.md @@ -14,10 +14,10 @@ Searches for specified query in the first name, last name and username of the kn ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query|[string](../types/string.md) | Yes|Query to search for, can be empty to return all contacts| -|limit|[int](../types/int.md) | Yes|Maximum number of users to be returned| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query|[string](../types/string.md) | Query to search for, can be empty to return all contacts | Yes| +|limit|[int](../types/int.md) | Maximum number of users to be returned | Yes| ### Return type: [Users](../types/Users.md) diff --git a/docs/TD_docs/methods/searchHashtags.md b/docs/TD_docs/methods/searchHashtags.md index d87a2d8b..dc51fd10 100644 --- a/docs/TD_docs/methods/searchHashtags.md +++ b/docs/TD_docs/methods/searchHashtags.md @@ -14,10 +14,10 @@ Searches for recently used hashtags by their prefix ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|prefix|[string](../types/string.md) | Yes|Hashtag prefix to search for| -|limit|[int](../types/int.md) | Yes|Maximum number of hashtags to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|prefix|[string](../types/string.md) | Hashtag prefix to search for | Yes| +|limit|[int](../types/int.md) | Maximum number of hashtags to return | Yes| ### Return type: [Hashtags](../types/Hashtags.md) diff --git a/docs/TD_docs/methods/searchMessages.md b/docs/TD_docs/methods/searchMessages.md index 4ee6be41..4d846275 100644 --- a/docs/TD_docs/methods/searchMessages.md +++ b/docs/TD_docs/methods/searchMessages.md @@ -14,13 +14,13 @@ Searches for messages in all chats except secret chats. Returns result in revers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query|[string](../types/string.md) | Yes|Query to search for| -|offset\_date|[int](../types/int.md) | Yes|Date of the message to search from, you can use 0 or any date in the future to get results from the beginning| -|offset\_chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the last found message or 0 for the first request| -|offset\_message\_id|[int53](../types/int53.md) | Yes|Message identifier of the last found message or 0 for the first request| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, at most 100| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query|[string](../types/string.md) | Query to search for | Yes| +|offset\_date|[int](../types/int.md) | Date of the message to search from, you can use 0 or any date in the future to get results from the beginning | Yes| +|offset\_chat\_id|[int53](../types/int53.md) | Chat identifier of the last found message or 0 for the first request | Yes| +|offset\_message\_id|[int53](../types/int53.md) | Message identifier of the last found message or 0 for the first request | Yes| +|limit|[int](../types/int.md) | Maximum number of messages to be returned, at most 100 | Yes| ### Return type: [Messages](../types/Messages.md) diff --git a/docs/TD_docs/methods/searchPublicChat.md b/docs/TD_docs/methods/searchPublicChat.md index d753002f..cfc39e99 100644 --- a/docs/TD_docs/methods/searchPublicChat.md +++ b/docs/TD_docs/methods/searchPublicChat.md @@ -14,9 +14,9 @@ Searches public chat by its username. Currently only private and channel chats c ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|username|[string](../types/string.md) | Yes|Username to be resolved| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|username|[string](../types/string.md) | Username to be resolved | Yes| ### Return type: [Chat](../types/Chat.md) diff --git a/docs/TD_docs/methods/searchPublicChats.md b/docs/TD_docs/methods/searchPublicChats.md index 821bcc0c..b3d97f79 100644 --- a/docs/TD_docs/methods/searchPublicChats.md +++ b/docs/TD_docs/methods/searchPublicChats.md @@ -14,9 +14,9 @@ Searches public chats by prefix of their username. Currently only private and ch ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|username\_prefix|[string](../types/string.md) | Yes|Prefix of the username to search| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|username\_prefix|[string](../types/string.md) | Prefix of the username to search | Yes| ### Return type: [Chats](../types/Chats.md) diff --git a/docs/TD_docs/methods/searchSecretMessages.md b/docs/TD_docs/methods/searchSecretMessages.md index a7cd71e8..29ea2d18 100644 --- a/docs/TD_docs/methods/searchSecretMessages.md +++ b/docs/TD_docs/methods/searchSecretMessages.md @@ -14,13 +14,13 @@ Searches for messages in secret chats. Returns result in reverse chronological o ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of a chat to search in. Specify 0 to search in all secret chats| -|query|[string](../types/string.md) | Yes|Query to search for. If empty, searchChatMessages should be used instead| -|from\_search\_id|[int64](../constructors/int64.md) | Yes|Identifier from the result of previous request, use 0 to get results from the beginning| -|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, can't be greater than 100| -|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Optional|Filter for content of searched messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Identifier of a chat to search in. Specify 0 to search in all secret chats | Yes| +|query|[string](../types/string.md) | Query to search for. If empty, searchChatMessages should be used instead | Yes| +|from\_search\_id|[int64](../constructors/int64.md) | Identifier from the result of previous request, use 0 to get results from the beginning | Yes| +|limit|[int](../types/int.md) | Maximum number of messages to be returned, can't be greater than 100 | Yes| +|filter|[SearchMessagesFilter](../types/SearchMessagesFilter.md) | Filter for content of searched messages | Optional| ### Return type: [FoundMessages](../types/FoundMessages.md) diff --git a/docs/TD_docs/methods/searchStickerSet.md b/docs/TD_docs/methods/searchStickerSet.md index e28c3d38..0d2df49b 100644 --- a/docs/TD_docs/methods/searchStickerSet.md +++ b/docs/TD_docs/methods/searchStickerSet.md @@ -14,9 +14,9 @@ Searches sticker set by its short name ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|name|[string](../types/string.md) | Yes|Name of the sticker set| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|name|[string](../types/string.md) | Name of the sticker set | Yes| ### Return type: [StickerSet](../types/StickerSet.md) diff --git a/docs/TD_docs/methods/sendBotStartMessage.md b/docs/TD_docs/methods/sendBotStartMessage.md index 9f5ba465..865e393f 100644 --- a/docs/TD_docs/methods/sendBotStartMessage.md +++ b/docs/TD_docs/methods/sendBotStartMessage.md @@ -14,11 +14,11 @@ Invites bot to a chat (if it is not in the chat) and send /start to it. Bot can' ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot\_user\_id|[int](../types/int.md) | Yes|Identifier of the bot| -|chat\_id|[int53](../types/int53.md) | Yes|Identifier of the chat| -|parameter|[string](../types/string.md) | Yes|Hidden parameter sent to bot for deep linking (https: api.telegram.org/bots#deep-linking)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot\_user\_id|[int](../types/int.md) | Identifier of the bot | Yes| +|chat\_id|[int53](../types/int53.md) | Identifier of the chat | Yes| +|parameter|[string](../types/string.md) | Hidden parameter sent to bot for deep linking (https: api.telegram.org/bots#deep-linking) | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendChatAction.md b/docs/TD_docs/methods/sendChatAction.md index 912e9467..2f57b4f2 100644 --- a/docs/TD_docs/methods/sendChatAction.md +++ b/docs/TD_docs/methods/sendChatAction.md @@ -14,10 +14,10 @@ Sends notification about user activity in a chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|action|[ChatAction](../types/ChatAction.md) | Yes|Action description| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|action|[ChatAction](../types/ChatAction.md) | Action description | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md b/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md index 76cf82f5..bcf5a19b 100644 --- a/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md +++ b/docs/TD_docs/methods/sendChatScreenshotTakenNotification.md @@ -14,9 +14,9 @@ Sends notification about screenshot taken in a chat. Works only in private and s ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/sendChatSetTtlMessage.md b/docs/TD_docs/methods/sendChatSetTtlMessage.md index 11bc6e97..279f8ff9 100644 --- a/docs/TD_docs/methods/sendChatSetTtlMessage.md +++ b/docs/TD_docs/methods/sendChatSetTtlMessage.md @@ -14,10 +14,10 @@ Changes current ttl setting in a secret chat and sends corresponding message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|ttl|[int](../types/int.md) | Yes|New value of ttl in seconds| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|ttl|[int](../types/int.md) | New value of ttl in seconds | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendCustomRequest.md b/docs/TD_docs/methods/sendCustomRequest.md index cddea147..4453ffd8 100644 --- a/docs/TD_docs/methods/sendCustomRequest.md +++ b/docs/TD_docs/methods/sendCustomRequest.md @@ -14,10 +14,10 @@ Bots only. Sends custom request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|method|[string](../types/string.md) | Yes|Method name| -|parameters|[string](../types/string.md) | Yes|JSON-serialized method parameters| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|method|[string](../types/string.md) | Method name | Yes| +|parameters|[string](../types/string.md) | JSON-serialized method parameters | Yes| ### Return type: [CustomRequestResult](../types/CustomRequestResult.md) diff --git a/docs/TD_docs/methods/sendInlineQueryResultMessage.md b/docs/TD_docs/methods/sendInlineQueryResultMessage.md index 93c7003d..c641ec63 100644 --- a/docs/TD_docs/methods/sendInlineQueryResultMessage.md +++ b/docs/TD_docs/methods/sendInlineQueryResultMessage.md @@ -14,14 +14,14 @@ Sends result of the inline query as a message. Returns sent message. Always clea ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat to send message| -|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| -|disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| -|from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| -|query\_id|[int64](../constructors/int64.md) | Yes|Identifier of the inline query| -|result\_id|[string](../types/string.md) | Yes|Identifier of the inline result| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat to send message | Yes| +|reply\_to\_message\_id|[int53](../types/int53.md) | Identifier of a message to reply to or 0 | Yes| +|disable\_notification|[Bool](../types/Bool.md) | Pass true, to disable notification about the message, doesn't works in secret chats | Yes| +|from\_background|[Bool](../types/Bool.md) | Pass true, if the message is sent from background | Yes| +|query\_id|[int64](../constructors/int64.md) | Identifier of the inline query | Yes| +|result\_id|[string](../types/string.md) | Identifier of the inline result | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendMessage.md b/docs/TD_docs/methods/sendMessage.md index 0003808a..785fe21d 100644 --- a/docs/TD_docs/methods/sendMessage.md +++ b/docs/TD_docs/methods/sendMessage.md @@ -14,14 +14,14 @@ Sends a message. Returns sent message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat to send message| -|reply\_to\_message\_id|[int53](../types/int53.md) | Yes|Identifier of a message to reply to or 0| -|disable\_notification|[Bool](../types/Bool.md) | Yes|Pass true, to disable notification about the message, doesn't works in secret chats| -|from\_background|[Bool](../types/Bool.md) | Yes|Pass true, if the message is sent from background| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Yes|Bots only. Markup for replying to message| -|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Yes|Content of a message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat to send message | Yes| +|reply\_to\_message\_id|[int53](../types/int53.md) | Identifier of a message to reply to or 0 | Yes| +|disable\_notification|[Bool](../types/Bool.md) | Pass true, to disable notification about the message, doesn't works in secret chats | Yes| +|from\_background|[Bool](../types/Bool.md) | Pass true, if the message is sent from background | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Bots only. Markup for replying to message | Yes| +|input\_message\_content|[InputMessageContent](../types/InputMessageContent.md) | Content of a message to send | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/sendPaymentForm.md b/docs/TD_docs/methods/sendPaymentForm.md index c9b64c3b..656fae12 100644 --- a/docs/TD_docs/methods/sendPaymentForm.md +++ b/docs/TD_docs/methods/sendPaymentForm.md @@ -14,13 +14,13 @@ Sends filled payment form to the bot for the final verification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| -|message\_id|[int53](../types/int53.md) | Yes|Message identifier| -|order\_info\_id|[string](../types/string.md) | Yes|Identifier returned by ValidateOrderInfo or empty string| -|shipping\_option\_id|[string](../types/string.md) | Yes|Identifier of a chosen shipping option, if applicable| -|credentials|[InputCredentials](../types/InputCredentials.md) | Yes|Credentials choosed by user for payment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier of the Invoice message | Yes| +|message\_id|[int53](../types/int53.md) | Message identifier | Yes| +|order\_info\_id|[string](../types/string.md) | Identifier returned by ValidateOrderInfo or empty string | Yes| +|shipping\_option\_id|[string](../types/string.md) | Identifier of a chosen shipping option, if applicable | Yes| +|credentials|[InputCredentials](../types/InputCredentials.md) | Credentials choosed by user for payment | Yes| ### Return type: [PaymentResult](../types/PaymentResult.md) diff --git a/docs/TD_docs/methods/setAlarm.md b/docs/TD_docs/methods/setAlarm.md index 3c2fefd4..1722fa28 100644 --- a/docs/TD_docs/methods/setAlarm.md +++ b/docs/TD_docs/methods/setAlarm.md @@ -14,9 +14,9 @@ Returns Ok after specified amount of the time passed. Can be called before autho ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|seconds|[double](../types/double.md) | Yes|Number of seconds before that function returns| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|seconds|[double](../types/double.md) | Number of seconds before that function returns | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setAuthPhoneNumber.md b/docs/TD_docs/methods/setAuthPhoneNumber.md index 7765797b..6eac1024 100644 --- a/docs/TD_docs/methods/setAuthPhoneNumber.md +++ b/docs/TD_docs/methods/setAuthPhoneNumber.md @@ -14,11 +14,11 @@ Sets user's phone number and sends authentication code to the user. Works only w ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|User's phone number in any reasonable format| -|allow\_flash\_call|[Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number| -|is\_current\_phone\_number|[Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | User's phone number in any reasonable format | Yes| +|allow\_flash\_call|[Bool](../types/Bool.md) | Pass True, if code can be sent via flash call to the specified phone number | Yes| +|is\_current\_phone\_number|[Bool](../types/Bool.md) | Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False | Yes| ### Return type: [AuthState](../types/AuthState.md) diff --git a/docs/TD_docs/methods/setBotUpdatesStatus.md b/docs/TD_docs/methods/setBotUpdatesStatus.md index 287779eb..37e8f739 100644 --- a/docs/TD_docs/methods/setBotUpdatesStatus.md +++ b/docs/TD_docs/methods/setBotUpdatesStatus.md @@ -14,10 +14,10 @@ Bots only. Informs server about number of pending bot updates if they aren't pro ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pending\_update\_count|[int](../types/int.md) | Yes|Number of pending updates| -|error\_message|[string](../types/string.md) | Yes|Last error's message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pending\_update\_count|[int](../types/int.md) | Number of pending updates | Yes| +|error\_message|[string](../types/string.md) | Last error's message | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setChannelStickerSet.md b/docs/TD_docs/methods/setChannelStickerSet.md index 66c8e11a..52f1b757 100644 --- a/docs/TD_docs/methods/setChannelStickerSet.md +++ b/docs/TD_docs/methods/setChannelStickerSet.md @@ -14,10 +14,10 @@ Changes sticker set of the channel. Needs appropriate rights in the channel ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|sticker\_set\_id|[int64](../constructors/int64.md) | Yes|New value of channel sticker set identifier. Use 0 to remove channel sticker set| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|sticker\_set\_id|[int64](../constructors/int64.md) | New value of channel sticker set identifier. Use 0 to remove channel sticker set | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setChatClientData.md b/docs/TD_docs/methods/setChatClientData.md index 6712642d..2ecba631 100644 --- a/docs/TD_docs/methods/setChatClientData.md +++ b/docs/TD_docs/methods/setChatClientData.md @@ -14,10 +14,10 @@ Changes client data associated with a chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|client\_data|[string](../types/string.md) | Yes|New value of client_data| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|client\_data|[string](../types/string.md) | New value of client_data | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setFileGenerationProgress.md b/docs/TD_docs/methods/setFileGenerationProgress.md index 0c20a70c..96090723 100644 --- a/docs/TD_docs/methods/setFileGenerationProgress.md +++ b/docs/TD_docs/methods/setFileGenerationProgress.md @@ -14,11 +14,11 @@ Next part of a file was generated ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|generation\_id|[int64](../constructors/int64.md) | Yes|Identifier of the generation process| -|size|[int](../types/int.md) | Yes|Full size of file in bytes, 0 if unknown.| -|local\_size|[int](../types/int.md) | Yes|Number of bytes already generated. Negative number means that generation has failed and should be terminated| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|generation\_id|[int64](../constructors/int64.md) | Identifier of the generation process | Yes| +|size|[int](../types/int.md) | Full size of file in bytes, 0 if unknown. | Yes| +|local\_size|[int](../types/int.md) | Number of bytes already generated. Negative number means that generation has failed and should be terminated | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setGameScore.md b/docs/TD_docs/methods/setGameScore.md index dc4f6057..1f24cc92 100644 --- a/docs/TD_docs/methods/setGameScore.md +++ b/docs/TD_docs/methods/setGameScore.md @@ -14,14 +14,14 @@ Bots only. Updates game score of the specified user in the game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat a message with the game belongs to| -|message\_id|[int53](../types/int53.md) | Yes|Identifier of the message| -|edit\_message|[Bool](../types/Bool.md) | Yes|True, if message should be edited| -|user\_id|[int](../types/int.md) | Yes|User identifier| -|score|[int](../types/int.md) | Yes|New score| -|force|[Bool](../types/Bool.md) | Yes|Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat a message with the game belongs to | Yes| +|message\_id|[int53](../types/int53.md) | Identifier of the message | Yes| +|edit\_message|[Bool](../types/Bool.md) | True, if message should be edited | Yes| +|user\_id|[int](../types/int.md) | User identifier | Yes| +|score|[int](../types/int.md) | New score | Yes| +|force|[Bool](../types/Bool.md) | Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table | Yes| ### Return type: [Message](../types/Message.md) diff --git a/docs/TD_docs/methods/setInlineGameScore.md b/docs/TD_docs/methods/setInlineGameScore.md index 58df68a0..1ea0fd28 100644 --- a/docs/TD_docs/methods/setInlineGameScore.md +++ b/docs/TD_docs/methods/setInlineGameScore.md @@ -14,13 +14,13 @@ Bots only. Updates game score of the specified user in the game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|inline\_message\_id|[string](../types/string.md) | Yes|Inline message identifier| -|edit\_message|[Bool](../types/Bool.md) | Yes|True, if message should be edited| -|user\_id|[int](../types/int.md) | Yes|User identifier| -|score|[int](../types/int.md) | Yes|New score| -|force|[Bool](../types/Bool.md) | Yes|Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|inline\_message\_id|[string](../types/string.md) | Inline message identifier | Yes| +|edit\_message|[Bool](../types/Bool.md) | True, if message should be edited | Yes| +|user\_id|[int](../types/int.md) | User identifier | Yes| +|score|[int](../types/int.md) | New score | Yes| +|force|[Bool](../types/Bool.md) | Pass True to update the score even if it decreases. If score is 0, user will be deleted from the high scores table | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setNetworkType.md b/docs/TD_docs/methods/setNetworkType.md index b8b4101b..faf05c0a 100644 --- a/docs/TD_docs/methods/setNetworkType.md +++ b/docs/TD_docs/methods/setNetworkType.md @@ -14,9 +14,9 @@ Sets current network type. Can be called before authorization. Call to this meth ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|type|[NetworkType](../types/NetworkType.md) | Yes|New network type, defaults to networkTypeNone| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|type|[NetworkType](../types/NetworkType.md) | New network type, defaults to networkTypeNone | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setNotificationSettings.md b/docs/TD_docs/methods/setNotificationSettings.md index 7a8c34a2..b387e06d 100644 --- a/docs/TD_docs/methods/setNotificationSettings.md +++ b/docs/TD_docs/methods/setNotificationSettings.md @@ -14,10 +14,10 @@ Changes notification settings for a given scope ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|scope|[NotificationSettingsScope](../types/NotificationSettingsScope.md) | Yes|Scope to change notification settings| -|notification\_settings|[notificationSettings](../constructors/notificationSettings.md) | Yes|New notification settings for given scope| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|scope|[NotificationSettingsScope](../types/NotificationSettingsScope.md) | Scope to change notification settings | Yes| +|notification\_settings|[notificationSettings](../constructors/notificationSettings.md) | New notification settings for given scope | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setOption.md b/docs/TD_docs/methods/setOption.md index 1df45aed..4b0f442f 100644 --- a/docs/TD_docs/methods/setOption.md +++ b/docs/TD_docs/methods/setOption.md @@ -14,10 +14,10 @@ Sets value of an option. See list of available options on https: core.telegram.o ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|name|[string](../types/string.md) | Yes|Name of the option| -|value|[OptionValue](../types/OptionValue.md) | Optional|New value of the option| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|name|[string](../types/string.md) | Name of the option | Yes| +|value|[OptionValue](../types/OptionValue.md) | New value of the option | Optional| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setPassword.md b/docs/TD_docs/methods/setPassword.md index ae2aeda0..935ea0b8 100644 --- a/docs/TD_docs/methods/setPassword.md +++ b/docs/TD_docs/methods/setPassword.md @@ -14,13 +14,13 @@ Changes user password. If new recovery email is specified, then error EMAIL_UNCO ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|old\_password|[string](../types/string.md) | Yes|Old user password| -|new\_password|[string](../types/string.md) | Yes|New user password, may be empty to remove the password| -|new\_hint|[string](../types/string.md) | Yes|New password hint, can be empty| -|set\_recovery\_email|[Bool](../types/Bool.md) | Yes|Pass True, if recovery email should be changed| -|new\_recovery\_email|[string](../types/string.md) | Yes|New recovery email, may be empty| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|old\_password|[string](../types/string.md) | Old user password | Yes| +|new\_password|[string](../types/string.md) | New user password, may be empty to remove the password | Yes| +|new\_hint|[string](../types/string.md) | New password hint, can be empty | Yes| +|set\_recovery\_email|[Bool](../types/Bool.md) | Pass True, if recovery email should be changed | Yes| +|new\_recovery\_email|[string](../types/string.md) | New recovery email, may be empty | Yes| ### Return type: [PasswordState](../types/PasswordState.md) diff --git a/docs/TD_docs/methods/setPinnedChats.md b/docs/TD_docs/methods/setPinnedChats.md index 64d3359d..478285b1 100644 --- a/docs/TD_docs/methods/setPinnedChats.md +++ b/docs/TD_docs/methods/setPinnedChats.md @@ -14,9 +14,9 @@ Changes list or order of pinned chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_ids|Array of [int53](../types/int53.md) | Yes|New list of pinned chats| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_ids|Array of [int53](../types/int53.md) | New list of pinned chats | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setPrivacy.md b/docs/TD_docs/methods/setPrivacy.md index 10a0d726..9f222452 100644 --- a/docs/TD_docs/methods/setPrivacy.md +++ b/docs/TD_docs/methods/setPrivacy.md @@ -14,10 +14,10 @@ Changes privacy settings ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|key|[PrivacyKey](../types/PrivacyKey.md) | Yes|Privacy key| -|rules|[privacyRules](../constructors/privacyRules.md) | Yes|New privacy rules| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|key|[PrivacyKey](../types/PrivacyKey.md) | Privacy key | Yes| +|rules|[privacyRules](../constructors/privacyRules.md) | New privacy rules | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setProfilePhoto.md b/docs/TD_docs/methods/setProfilePhoto.md index e8a42821..707d5dc1 100644 --- a/docs/TD_docs/methods/setProfilePhoto.md +++ b/docs/TD_docs/methods/setProfilePhoto.md @@ -14,9 +14,9 @@ Uploads new profile photo for logged in user. If something changes, updateUser w ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|photo|[InputFile](../types/InputFile.md) | Yes|Profile photo to set. inputFileId and inputFilePersistentId may be unsupported| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|photo|[InputFile](../types/InputFile.md) | Profile photo to set. inputFileId and inputFilePersistentId may be unsupported | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setProxy.md b/docs/TD_docs/methods/setProxy.md index 4d1a6048..48a3640f 100644 --- a/docs/TD_docs/methods/setProxy.md +++ b/docs/TD_docs/methods/setProxy.md @@ -14,9 +14,9 @@ Sets proxy server for network requests. Can be called before authorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|proxy|[Proxy](../types/Proxy.md) | Optional|The proxy to use. You can specify null to remove proxy server| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|proxy|[Proxy](../types/Proxy.md) | The proxy to use. You can specify null to remove proxy server | Optional| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/setRecoveryEmail.md b/docs/TD_docs/methods/setRecoveryEmail.md index 1a21f61f..f204e2fd 100644 --- a/docs/TD_docs/methods/setRecoveryEmail.md +++ b/docs/TD_docs/methods/setRecoveryEmail.md @@ -14,10 +14,10 @@ Changes user recovery email. If new recovery email is specified, then error EMAI ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|password|[string](../types/string.md) | Yes|Current user password| -|new\_recovery\_email|[string](../types/string.md) | Yes|New recovery email| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|password|[string](../types/string.md) | Current user password | Yes| +|new\_recovery\_email|[string](../types/string.md) | New recovery email | Yes| ### Return type: [PasswordState](../types/PasswordState.md) diff --git a/docs/TD_docs/methods/setStickerPositionInSet.md b/docs/TD_docs/methods/setStickerPositionInSet.md index 91beb207..da9a8606 100644 --- a/docs/TD_docs/methods/setStickerPositionInSet.md +++ b/docs/TD_docs/methods/setStickerPositionInSet.md @@ -14,10 +14,10 @@ Bots only. Changes position of a sticker in the set it belongs to. Sticker set s ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[InputFile](../types/InputFile.md) | Yes|The sticker| -|position|[int](../types/int.md) | Yes|New sticker position in the set, zero-based| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[InputFile](../types/InputFile.md) | The sticker | Yes| +|position|[int](../types/int.md) | New sticker position in the set, zero-based | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/terminateSession.md b/docs/TD_docs/methods/terminateSession.md index 4ae33d92..c3d12cd0 100644 --- a/docs/TD_docs/methods/terminateSession.md +++ b/docs/TD_docs/methods/terminateSession.md @@ -14,9 +14,9 @@ Terminates another session of logged in user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[int64](../constructors/int64.md) | Yes|Session identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[int64](../constructors/int64.md) | Session identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/testCallBytes.md b/docs/TD_docs/methods/testCallBytes.md index 689c002b..2f12dfd9 100644 --- a/docs/TD_docs/methods/testCallBytes.md +++ b/docs/TD_docs/methods/testCallBytes.md @@ -14,9 +14,9 @@ Test request. Returns back received bytes ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|[bytes](../types/bytes.md) | Yes|Bytes to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|[bytes](../types/bytes.md) | Bytes to return | Yes| ### Return type: [TestBytes](../types/TestBytes.md) diff --git a/docs/TD_docs/methods/testCallString.md b/docs/TD_docs/methods/testCallString.md index 1590a45b..8041de19 100644 --- a/docs/TD_docs/methods/testCallString.md +++ b/docs/TD_docs/methods/testCallString.md @@ -14,9 +14,9 @@ Test request. Returns back received string ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|[string](../types/string.md) | Yes|String to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|[string](../types/string.md) | String to return | Yes| ### Return type: [TestString](../types/TestString.md) diff --git a/docs/TD_docs/methods/testCallVectorInt.md b/docs/TD_docs/methods/testCallVectorInt.md index aa3c583a..94bbc018 100644 --- a/docs/TD_docs/methods/testCallVectorInt.md +++ b/docs/TD_docs/methods/testCallVectorInt.md @@ -14,9 +14,9 @@ Test request. Returns back received vector of numbers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|Array of [int](../types/int.md) | Yes|Vector of numbers to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|Array of [int](../types/int.md) | Vector of numbers to return | Yes| ### Return type: [TestVectorInt](../types/TestVectorInt.md) diff --git a/docs/TD_docs/methods/testCallVectorIntObject.md b/docs/TD_docs/methods/testCallVectorIntObject.md index 5a0853f0..82c18d61 100644 --- a/docs/TD_docs/methods/testCallVectorIntObject.md +++ b/docs/TD_docs/methods/testCallVectorIntObject.md @@ -14,9 +14,9 @@ Test request. Returns back received vector of objects containing a number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|Array of [testInt](../constructors/testInt.md) | Yes|Vector of objects to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|Array of [testInt](../constructors/testInt.md) | Vector of objects to return | Yes| ### Return type: [TestVectorIntObject](../types/TestVectorIntObject.md) diff --git a/docs/TD_docs/methods/testCallVectorString.md b/docs/TD_docs/methods/testCallVectorString.md index 1a8f48f8..9ece8b31 100644 --- a/docs/TD_docs/methods/testCallVectorString.md +++ b/docs/TD_docs/methods/testCallVectorString.md @@ -14,9 +14,9 @@ Test request. Returns back received vector of strings ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|Array of [string](../types/string.md) | Yes|Vector of strings to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|Array of [string](../types/string.md) | Vector of strings to return | Yes| ### Return type: [TestVectorString](../types/TestVectorString.md) diff --git a/docs/TD_docs/methods/testCallVectorStringObject.md b/docs/TD_docs/methods/testCallVectorStringObject.md index a54eb5ec..dda8002d 100644 --- a/docs/TD_docs/methods/testCallVectorStringObject.md +++ b/docs/TD_docs/methods/testCallVectorStringObject.md @@ -14,9 +14,9 @@ Test request. Returns back received vector of objects containing a string ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|Array of [testString](../constructors/testString.md) | Yes|Vector of objects to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|Array of [testString](../constructors/testString.md) | Vector of objects to return | Yes| ### Return type: [TestVectorStringObject](../types/TestVectorStringObject.md) diff --git a/docs/TD_docs/methods/testSquareInt.md b/docs/TD_docs/methods/testSquareInt.md index d4d28d7e..fcafc01f 100644 --- a/docs/TD_docs/methods/testSquareInt.md +++ b/docs/TD_docs/methods/testSquareInt.md @@ -14,9 +14,9 @@ Test request. Returns squared received number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|x|[int](../types/int.md) | Yes|Number to square| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|x|[int](../types/int.md) | Number to square | Yes| ### Return type: [TestInt](../types/TestInt.md) diff --git a/docs/TD_docs/methods/toggleChannelInvites.md b/docs/TD_docs/methods/toggleChannelInvites.md index 89231d01..7e67a0ba 100644 --- a/docs/TD_docs/methods/toggleChannelInvites.md +++ b/docs/TD_docs/methods/toggleChannelInvites.md @@ -14,10 +14,10 @@ Gives or revokes right to invite new members to all current members of the chann ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|anyone\_can\_invite|[Bool](../types/Bool.md) | Yes|New value of anyone_can_invite| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|anyone\_can\_invite|[Bool](../types/Bool.md) | New value of anyone_can_invite | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/toggleChannelSignMessages.md b/docs/TD_docs/methods/toggleChannelSignMessages.md index 50f65f01..4523f064 100644 --- a/docs/TD_docs/methods/toggleChannelSignMessages.md +++ b/docs/TD_docs/methods/toggleChannelSignMessages.md @@ -14,10 +14,10 @@ Enables or disables sender signature on sent messages in the channel. Needs appr ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| -|sign\_messages|[Bool](../types/Bool.md) | Yes|New value of sign_messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| +|sign\_messages|[Bool](../types/Bool.md) | New value of sign_messages | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/toggleChatIsPinned.md b/docs/TD_docs/methods/toggleChatIsPinned.md index f150cf00..b4a0579e 100644 --- a/docs/TD_docs/methods/toggleChatIsPinned.md +++ b/docs/TD_docs/methods/toggleChatIsPinned.md @@ -14,10 +14,10 @@ Changes chat pinned state. You can pin up to getOption("pinned_chat_count_max") ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|is\_pinned|[Bool](../types/Bool.md) | Yes|New value of is_pinned| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|is\_pinned|[Bool](../types/Bool.md) | New value of is_pinned | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/toggleGroupAdministrators.md b/docs/TD_docs/methods/toggleGroupAdministrators.md index c1781e73..3c4b27c9 100644 --- a/docs/TD_docs/methods/toggleGroupAdministrators.md +++ b/docs/TD_docs/methods/toggleGroupAdministrators.md @@ -14,10 +14,10 @@ Gives or revokes all members of the group administrator rights. Needs creator pr ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|group\_id|[int](../types/int.md) | Yes|Identifier of the group| -|everyone\_is\_administrator|[Bool](../types/Bool.md) | Yes|New value of everyone_is_administrator| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|group\_id|[int](../types/int.md) | Identifier of the group | Yes| +|everyone\_is\_administrator|[Bool](../types/Bool.md) | New value of everyone_is_administrator | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/unblockUser.md b/docs/TD_docs/methods/unblockUser.md index bcd230bb..bf1aef22 100644 --- a/docs/TD_docs/methods/unblockUser.md +++ b/docs/TD_docs/methods/unblockUser.md @@ -14,9 +14,9 @@ Removes user from black list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|User identifier| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | User identifier | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/unpinChannelMessage.md b/docs/TD_docs/methods/unpinChannelMessage.md index 94cca21b..ebbb9203 100644 --- a/docs/TD_docs/methods/unpinChannelMessage.md +++ b/docs/TD_docs/methods/unpinChannelMessage.md @@ -14,9 +14,9 @@ Removes pinned message in the supergroup channel. Needs appropriate rights in th ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel\_id|[int](../types/int.md) | Yes|Identifier of the channel| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel\_id|[int](../types/int.md) | Identifier of the channel | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/uploadFile.md b/docs/TD_docs/methods/uploadFile.md index 74adbe8a..806a437a 100644 --- a/docs/TD_docs/methods/uploadFile.md +++ b/docs/TD_docs/methods/uploadFile.md @@ -14,11 +14,11 @@ Asynchronously uploads file to the cloud without sending it in a message. Update ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[InputFile](../types/InputFile.md) | Yes|File to upload| -|file\_type|[FileType](../types/FileType.md) | Yes|File type| -|priority|[int](../types/int.md) | Yes|Priority of upload, 1-32. The higher priority, the earlier file will be uploaded. If priorities of two files are equal then the first one for which uploadFile is called will be uploaded first| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[InputFile](../types/InputFile.md) | File to upload | Yes| +|file\_type|[FileType](../types/FileType.md) | File type | Yes| +|priority|[int](../types/int.md) | Priority of upload, 1-32. The higher priority, the earlier file will be uploaded. If priorities of two files are equal then the first one for which uploadFile is called will be uploaded first | Yes| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/uploadStickerFile.md b/docs/TD_docs/methods/uploadStickerFile.md index 4430bc3a..38c15b2d 100644 --- a/docs/TD_docs/methods/uploadStickerFile.md +++ b/docs/TD_docs/methods/uploadStickerFile.md @@ -14,10 +14,10 @@ Bots only. Uploads a png image with a sticker. Returns uploaded file ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[int](../types/int.md) | Yes|Sticker file owner| -|png\_sticker|[InputFile](../types/InputFile.md) | Yes|Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[int](../types/int.md) | Sticker file owner | Yes| +|png\_sticker|[InputFile](../types/InputFile.md) | Png image with the sticker, must be up to 512 kilobytes in size and fit in 512x512 square | Yes| ### Return type: [File](../types/File.md) diff --git a/docs/TD_docs/methods/validateOrderInfo.md b/docs/TD_docs/methods/validateOrderInfo.md index e14f10bb..d1fed0ed 100644 --- a/docs/TD_docs/methods/validateOrderInfo.md +++ b/docs/TD_docs/methods/validateOrderInfo.md @@ -14,12 +14,12 @@ Validates order information provided by the user and returns available shipping ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier of the Invoice message| -|message\_id|[int53](../types/int53.md) | Yes|Message identifier| -|order\_info|[orderInfo](../constructors/orderInfo.md) | Yes|Order information, provided by the user| -|allow\_save|[Bool](../types/Bool.md) | Yes|True, if order information can be saved| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier of the Invoice message | Yes| +|message\_id|[int53](../types/int53.md) | Message identifier | Yes| +|order\_info|[orderInfo](../constructors/orderInfo.md) | Order information, provided by the user | Yes| +|allow\_save|[Bool](../types/Bool.md) | True, if order information can be saved | Yes| ### Return type: [ValidatedOrderInfo](../types/ValidatedOrderInfo.md) diff --git a/docs/TD_docs/methods/viewMessages.md b/docs/TD_docs/methods/viewMessages.md index 79fa249e..75746c1e 100644 --- a/docs/TD_docs/methods/viewMessages.md +++ b/docs/TD_docs/methods/viewMessages.md @@ -14,10 +14,10 @@ Messages are viewed by the user. Many useful activities depends on message being ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[int53](../types/int53.md) | Yes|Chat identifier| -|message\_ids|Array of [int53](../types/int53.md) | Yes|Identifiers of viewed messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[int53](../types/int53.md) | Chat identifier | Yes| +|message\_ids|Array of [int53](../types/int53.md) | Identifiers of viewed messages | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/docs/TD_docs/methods/viewTrendingStickerSets.md b/docs/TD_docs/methods/viewTrendingStickerSets.md index 8dee5d3f..c8c8de79 100644 --- a/docs/TD_docs/methods/viewTrendingStickerSets.md +++ b/docs/TD_docs/methods/viewTrendingStickerSets.md @@ -14,9 +14,9 @@ Informs that some trending sticker sets are viewed by the user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker\_set\_ids|Array of [int64](../constructors/int64.md) | Yes|Identifiers of viewed trending sticker sets| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker\_set\_ids|Array of [int64](../constructors/int64.md) | Identifiers of viewed trending sticker sets | Yes| ### Return type: [Ok](../types/Ok.md) diff --git a/old_docs/API_docs_v18/methods/account_checkUsername.md b/old_docs/API_docs_v18/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v18/methods/account_checkUsername.md +++ b/old_docs/API_docs_v18/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/account_getNotifySettings.md b/old_docs/API_docs_v18/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v18/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v18/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/account_registerDevice.md b/old_docs/API_docs_v18/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v18/methods/account_registerDevice.md +++ b/old_docs/API_docs_v18/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/account_unregisterDevice.md b/old_docs/API_docs_v18/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v18/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v18/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/account_updateNotifySettings.md b/old_docs/API_docs_v18/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v18/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v18/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/account_updateProfile.md b/old_docs/API_docs_v18/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v18/methods/account_updateProfile.md +++ b/old_docs/API_docs_v18/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v18/methods/account_updateStatus.md b/old_docs/API_docs_v18/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v18/methods/account_updateStatus.md +++ b/old_docs/API_docs_v18/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/account_updateUsername.md b/old_docs/API_docs_v18/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v18/methods/account_updateUsername.md +++ b/old_docs/API_docs_v18/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/auth_checkPhone.md b/old_docs/API_docs_v18/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v18/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v18/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v18/methods/auth_sendCall.md b/old_docs/API_docs_v18/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v18/methods/auth_sendCall.md +++ b/old_docs/API_docs_v18/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/auth_sendInvites.md b/old_docs/API_docs_v18/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v18/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v18/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/auth_sendSms.md b/old_docs/API_docs_v18/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v18/methods/auth_sendSms.md +++ b/old_docs/API_docs_v18/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/contacts_block.md b/old_docs/API_docs_v18/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v18/methods/contacts_block.md +++ b/old_docs/API_docs_v18/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/contacts_deleteContact.md b/old_docs/API_docs_v18/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v18/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v18/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/contacts_deleteContacts.md b/old_docs/API_docs_v18/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v18/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v18/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/contacts_getBlocked.md b/old_docs/API_docs_v18/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v18/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v18/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/contacts_getContacts.md b/old_docs/API_docs_v18/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v18/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v18/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v18/methods/contacts_getSuggested.md b/old_docs/API_docs_v18/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v18/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v18/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v18/methods/contacts_importCard.md b/old_docs/API_docs_v18/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v18/methods/contacts_importCard.md +++ b/old_docs/API_docs_v18/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/contacts_importContacts.md b/old_docs/API_docs_v18/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v18/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v18/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v18/methods/contacts_search.md b/old_docs/API_docs_v18/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v18/methods/contacts_search.md +++ b/old_docs/API_docs_v18/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/contacts_unblock.md b/old_docs/API_docs_v18/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v18/methods/contacts_unblock.md +++ b/old_docs/API_docs_v18/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/help_getAppUpdate.md b/old_docs/API_docs_v18/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v18/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v18/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v18/methods/help_getInviteText.md b/old_docs/API_docs_v18/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v18/methods/help_getInviteText.md +++ b/old_docs/API_docs_v18/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v18/methods/help_saveAppLog.md b/old_docs/API_docs_v18/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v18/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v18/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/initConnection.md b/old_docs/API_docs_v18/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v18/methods/initConnection.md +++ b/old_docs/API_docs_v18/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v18/methods/invokeAfterMsg.md b/old_docs/API_docs_v18/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v18/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v18/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/invokeAfterMsgs.md b/old_docs/API_docs_v18/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v18/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v18/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v18/methods/invokeWithLayer18.md b/old_docs/API_docs_v18/methods/invokeWithLayer18.md index 01032302..934e4095 100644 --- a/old_docs/API_docs_v18/methods/invokeWithLayer18.md +++ b/old_docs/API_docs_v18/methods/invokeWithLayer18.md @@ -11,9 +11,9 @@ Invoke this method with layer 18 ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query|[!X](../types/!X.md) | Yes|The method call| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query|[!X](../types/!X.md) | The method call | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v18/methods/messages_addChatUser.md b/old_docs/API_docs_v18/methods/messages_addChatUser.md index f25db775..07f88f50 100644 --- a/old_docs/API_docs_v18/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v18/methods/messages_addChatUser.md @@ -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: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_createChat.md b/old_docs/API_docs_v18/methods/messages_createChat.md index 8a9c9c21..801a3c7e 100644 --- a/old_docs/API_docs_v18/methods/messages_createChat.md +++ b/old_docs/API_docs_v18/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_deleteChatUser.md b/old_docs/API_docs_v18/methods/messages_deleteChatUser.md index 4b355cfb..6a3db15d 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v18/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_deleteHistory.md b/old_docs/API_docs_v18/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v18/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v18/methods/messages_deleteMessages.md b/old_docs/API_docs_v18/methods/messages_deleteMessages.md index aa9c3ba4..e835ba35 100644 --- a/old_docs/API_docs_v18/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v18/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v18/methods/messages_editChatPhoto.md b/old_docs/API_docs_v18/methods/messages_editChatPhoto.md index 11b913b3..a0564d0d 100644 --- a/old_docs/API_docs_v18/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v18/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_editChatTitle.md b/old_docs/API_docs_v18/methods/messages_editChatTitle.md index b9daa120..e51d4f1c 100644 --- a/old_docs/API_docs_v18/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v18/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_forwardMessage.md b/old_docs/API_docs_v18/methods/messages_forwardMessage.md index b6532853..5f1ec345 100644 --- a/old_docs/API_docs_v18/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v18/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_forwardMessages.md b/old_docs/API_docs_v18/methods/messages_forwardMessages.md index 0cc322d0..1c990900 100644 --- a/old_docs/API_docs_v18/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v18/methods/messages_forwardMessages.md @@ -11,10 +11,10 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [int](../types/int.md) | Yes|The message IDs| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) diff --git a/old_docs/API_docs_v18/methods/messages_getChats.md b/old_docs/API_docs_v18/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v18/methods/messages_getChats.md +++ b/old_docs/API_docs_v18/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v18/methods/messages_getDialogs.md b/old_docs/API_docs_v18/methods/messages_getDialogs.md index 8606087d..c93f1d1c 100644 --- a/old_docs/API_docs_v18/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v18/methods/messages_getDialogs.md @@ -11,11 +11,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of result to return | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v18/methods/messages_getHistory.md b/old_docs/API_docs_v18/methods/messages_getHistory.md index 52f56819..f8240098 100644 --- a/old_docs/API_docs_v18/methods/messages_getHistory.md +++ b/old_docs/API_docs_v18/methods/messages_getHistory.md @@ -11,12 +11,12 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[int](../types/int.md) | Yes|Message ID offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset|[int](../types/int.md) | Message ID offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v18/methods/messages_getMessages.md b/old_docs/API_docs_v18/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v18/methods/messages_getMessages.md +++ b/old_docs/API_docs_v18/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v18/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/messages_readHistory.md b/old_docs/API_docs_v18/methods/messages_readHistory.md index 7b358f31..d9c8528b 100644 --- a/old_docs/API_docs_v18/methods/messages_readHistory.md +++ b/old_docs/API_docs_v18/methods/messages_readHistory.md @@ -11,12 +11,12 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| -|read\_contents|[Bool](../types/Bool.md) | Yes|Mark messages as read?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|read\_contents|[Bool](../types/Bool.md) | Mark messages as read? | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v18/methods/messages_readMessageContents.md b/old_docs/API_docs_v18/methods/messages_readMessageContents.md index 4e1d1875..aaa5814c 100644 --- a/old_docs/API_docs_v18/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v18/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v18/methods/messages_receivedMessages.md b/old_docs/API_docs_v18/methods/messages_receivedMessages.md index 032496e5..44dc6a71 100644 --- a/old_docs/API_docs_v18/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v18/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v18/methods/messages_reportSpam.md b/old_docs/API_docs_v18/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v18/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v18/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/messages_search.md b/old_docs/API_docs_v18/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v18/methods/messages_search.md +++ b/old_docs/API_docs_v18/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendBroadcast.md b/old_docs/API_docs_v18/methods/messages_sendBroadcast.md index fedd6177..c77c6e1e 100644 --- a/old_docs/API_docs_v18/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v18/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendEncrypted.md b/old_docs/API_docs_v18/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v18/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_sendMedia.md b/old_docs/API_docs_v18/methods/messages_sendMedia.md index 0526adfc..aedc1fff 100644 --- a/old_docs/API_docs_v18/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v18/methods/messages_sendMedia.md @@ -11,10 +11,10 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -79,6 +79,7 @@ messages_StatedMessage = messages.sendMedia({peer=InputPeer, media=InputMedia, } |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v18/methods/messages_sendMessage.md b/old_docs/API_docs_v18/methods/messages_sendMessage.md index 41bf1236..4ba067a4 100644 --- a/old_docs/API_docs_v18/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v18/methods/messages_sendMessage.md @@ -11,10 +11,10 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) diff --git a/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v18/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/messages_setTyping.md b/old_docs/API_docs_v18/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v18/methods/messages_setTyping.md +++ b/old_docs/API_docs_v18/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v18/methods/photos_deletePhotos.md b/old_docs/API_docs_v18/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v18/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v18/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v18/methods/photos_getUserPhotos.md b/old_docs/API_docs_v18/methods/photos_getUserPhotos.md index 83659b20..fef30862 100644 --- a/old_docs/API_docs_v18/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v18/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v18/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v18/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v18/methods/users_getUsers.md b/old_docs/API_docs_v18/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v18/methods/users_getUsers.md +++ b/old_docs/API_docs_v18/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v23/methods/account_changePhone.md b/old_docs/API_docs_v23/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v23/methods/account_changePhone.md +++ b/old_docs/API_docs_v23/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_checkUsername.md b/old_docs/API_docs_v23/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v23/methods/account_checkUsername.md +++ b/old_docs/API_docs_v23/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_deleteAccount.md b/old_docs/API_docs_v23/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v23/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v23/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_getNotifySettings.md b/old_docs/API_docs_v23/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v23/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v23/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_getPrivacy.md b/old_docs/API_docs_v23/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v23/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v23/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_registerDevice.md b/old_docs/API_docs_v23/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v23/methods/account_registerDevice.md +++ b/old_docs/API_docs_v23/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/account_reportPeer.md b/old_docs/API_docs_v23/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v23/methods/account_reportPeer.md +++ b/old_docs/API_docs_v23/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v23/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v23/methods/account_setAccountTTL.md b/old_docs/API_docs_v23/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v23/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v23/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_setPrivacy.md b/old_docs/API_docs_v23/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v23/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v23/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_unregisterDevice.md b/old_docs/API_docs_v23/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v23/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v23/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v23/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_updateNotifySettings.md b/old_docs/API_docs_v23/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v23/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v23/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_updateProfile.md b/old_docs/API_docs_v23/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v23/methods/account_updateProfile.md +++ b/old_docs/API_docs_v23/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v23/methods/account_updateStatus.md b/old_docs/API_docs_v23/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v23/methods/account_updateStatus.md +++ b/old_docs/API_docs_v23/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/account_updateUsername.md b/old_docs/API_docs_v23/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v23/methods/account_updateUsername.md +++ b/old_docs/API_docs_v23/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/auth_checkPhone.md b/old_docs/API_docs_v23/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v23/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v23/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v23/methods/auth_sendCall.md b/old_docs/API_docs_v23/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v23/methods/auth_sendCall.md +++ b/old_docs/API_docs_v23/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/auth_sendInvites.md b/old_docs/API_docs_v23/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v23/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v23/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/auth_sendSms.md b/old_docs/API_docs_v23/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v23/methods/auth_sendSms.md +++ b/old_docs/API_docs_v23/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/contacts_block.md b/old_docs/API_docs_v23/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v23/methods/contacts_block.md +++ b/old_docs/API_docs_v23/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/contacts_deleteContact.md b/old_docs/API_docs_v23/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v23/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v23/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/contacts_deleteContacts.md b/old_docs/API_docs_v23/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v23/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v23/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/contacts_getBlocked.md b/old_docs/API_docs_v23/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v23/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v23/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/contacts_getContacts.md b/old_docs/API_docs_v23/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v23/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v23/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v23/methods/contacts_getSuggested.md b/old_docs/API_docs_v23/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v23/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v23/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v23/methods/contacts_importCard.md b/old_docs/API_docs_v23/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v23/methods/contacts_importCard.md +++ b/old_docs/API_docs_v23/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/contacts_importContacts.md b/old_docs/API_docs_v23/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v23/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v23/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v23/methods/contacts_search.md b/old_docs/API_docs_v23/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v23/methods/contacts_search.md +++ b/old_docs/API_docs_v23/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/contacts_unblock.md b/old_docs/API_docs_v23/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v23/methods/contacts_unblock.md +++ b/old_docs/API_docs_v23/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/help_getAppUpdate.md b/old_docs/API_docs_v23/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v23/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v23/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v23/methods/help_getInviteText.md b/old_docs/API_docs_v23/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v23/methods/help_getInviteText.md +++ b/old_docs/API_docs_v23/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v23/methods/help_saveAppLog.md b/old_docs/API_docs_v23/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v23/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v23/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/initConnection.md b/old_docs/API_docs_v23/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v23/methods/initConnection.md +++ b/old_docs/API_docs_v23/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v23/methods/invokeAfterMsg.md b/old_docs/API_docs_v23/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v23/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v23/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/invokeAfterMsgs.md b/old_docs/API_docs_v23/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v23/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v23/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/invokeWithLayer.md b/old_docs/API_docs_v23/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v23/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v23/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v23/methods/messages_addChatUser.md b/old_docs/API_docs_v23/methods/messages_addChatUser.md index f25db775..07f88f50 100644 --- a/old_docs/API_docs_v23/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v23/methods/messages_addChatUser.md @@ -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: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_createChat.md b/old_docs/API_docs_v23/methods/messages_createChat.md index 8a9c9c21..801a3c7e 100644 --- a/old_docs/API_docs_v23/methods/messages_createChat.md +++ b/old_docs/API_docs_v23/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_deleteChatUser.md b/old_docs/API_docs_v23/methods/messages_deleteChatUser.md index 4b355cfb..6a3db15d 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v23/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_deleteHistory.md b/old_docs/API_docs_v23/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v23/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v23/methods/messages_deleteMessages.md b/old_docs/API_docs_v23/methods/messages_deleteMessages.md index aa9c3ba4..e835ba35 100644 --- a/old_docs/API_docs_v23/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v23/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v23/methods/messages_editChatPhoto.md b/old_docs/API_docs_v23/methods/messages_editChatPhoto.md index 11b913b3..a0564d0d 100644 --- a/old_docs/API_docs_v23/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v23/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_editChatTitle.md b/old_docs/API_docs_v23/methods/messages_editChatTitle.md index b9daa120..e51d4f1c 100644 --- a/old_docs/API_docs_v23/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v23/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_forwardMessage.md b/old_docs/API_docs_v23/methods/messages_forwardMessage.md index b6532853..5f1ec345 100644 --- a/old_docs/API_docs_v23/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v23/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_forwardMessages.md b/old_docs/API_docs_v23/methods/messages_forwardMessages.md index 0cc322d0..1c990900 100644 --- a/old_docs/API_docs_v23/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v23/methods/messages_forwardMessages.md @@ -11,10 +11,10 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [int](../types/int.md) | Yes|The message IDs| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) diff --git a/old_docs/API_docs_v23/methods/messages_getAllStickers.md b/old_docs/API_docs_v23/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v23/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v23/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v23/methods/messages_getChats.md b/old_docs/API_docs_v23/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v23/methods/messages_getChats.md +++ b/old_docs/API_docs_v23/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v23/methods/messages_getDialogs.md b/old_docs/API_docs_v23/methods/messages_getDialogs.md index 8606087d..c93f1d1c 100644 --- a/old_docs/API_docs_v23/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v23/methods/messages_getDialogs.md @@ -11,11 +11,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of result to return | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v23/methods/messages_getHistory.md b/old_docs/API_docs_v23/methods/messages_getHistory.md index 52f56819..f8240098 100644 --- a/old_docs/API_docs_v23/methods/messages_getHistory.md +++ b/old_docs/API_docs_v23/methods/messages_getHistory.md @@ -11,12 +11,12 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[int](../types/int.md) | Yes|Message ID offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset|[int](../types/int.md) | Message ID offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v23/methods/messages_getMessages.md b/old_docs/API_docs_v23/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v23/methods/messages_getMessages.md +++ b/old_docs/API_docs_v23/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v23/methods/messages_getStickers.md b/old_docs/API_docs_v23/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v23/methods/messages_getStickers.md +++ b/old_docs/API_docs_v23/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v23/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/messages_readHistory.md b/old_docs/API_docs_v23/methods/messages_readHistory.md index 7b358f31..d9c8528b 100644 --- a/old_docs/API_docs_v23/methods/messages_readHistory.md +++ b/old_docs/API_docs_v23/methods/messages_readHistory.md @@ -11,12 +11,12 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| -|read\_contents|[Bool](../types/Bool.md) | Yes|Mark messages as read?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|read\_contents|[Bool](../types/Bool.md) | Mark messages as read? | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v23/methods/messages_readMessageContents.md b/old_docs/API_docs_v23/methods/messages_readMessageContents.md index 4e1d1875..aaa5814c 100644 --- a/old_docs/API_docs_v23/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v23/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v23/methods/messages_receivedMessages.md b/old_docs/API_docs_v23/methods/messages_receivedMessages.md index 032496e5..44dc6a71 100644 --- a/old_docs/API_docs_v23/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v23/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v23/methods/messages_reportSpam.md b/old_docs/API_docs_v23/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v23/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v23/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/messages_search.md b/old_docs/API_docs_v23/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v23/methods/messages_search.md +++ b/old_docs/API_docs_v23/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendBroadcast.md b/old_docs/API_docs_v23/methods/messages_sendBroadcast.md index fedd6177..c77c6e1e 100644 --- a/old_docs/API_docs_v23/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v23/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendEncrypted.md b/old_docs/API_docs_v23/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v23/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_sendMedia.md b/old_docs/API_docs_v23/methods/messages_sendMedia.md index 0526adfc..aedc1fff 100644 --- a/old_docs/API_docs_v23/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v23/methods/messages_sendMedia.md @@ -11,10 +11,10 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -79,6 +79,7 @@ messages_StatedMessage = messages.sendMedia({peer=InputPeer, media=InputMedia, } |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v23/methods/messages_sendMessage.md b/old_docs/API_docs_v23/methods/messages_sendMessage.md index 41bf1236..4ba067a4 100644 --- a/old_docs/API_docs_v23/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v23/methods/messages_sendMessage.md @@ -11,10 +11,10 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) diff --git a/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v23/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/messages_setTyping.md b/old_docs/API_docs_v23/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v23/methods/messages_setTyping.md +++ b/old_docs/API_docs_v23/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v23/methods/photos_deletePhotos.md b/old_docs/API_docs_v23/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v23/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v23/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v23/methods/photos_getUserPhotos.md b/old_docs/API_docs_v23/methods/photos_getUserPhotos.md index 83659b20..fef30862 100644 --- a/old_docs/API_docs_v23/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v23/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v23/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v23/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v23/methods/users_getUsers.md b/old_docs/API_docs_v23/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v23/methods/users_getUsers.md +++ b/old_docs/API_docs_v23/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v25/methods/account_changePhone.md b/old_docs/API_docs_v25/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v25/methods/account_changePhone.md +++ b/old_docs/API_docs_v25/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_checkUsername.md b/old_docs/API_docs_v25/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v25/methods/account_checkUsername.md +++ b/old_docs/API_docs_v25/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_deleteAccount.md b/old_docs/API_docs_v25/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v25/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v25/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_getNotifySettings.md b/old_docs/API_docs_v25/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v25/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v25/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_getPrivacy.md b/old_docs/API_docs_v25/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v25/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v25/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_registerDevice.md b/old_docs/API_docs_v25/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v25/methods/account_registerDevice.md +++ b/old_docs/API_docs_v25/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v25/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v25/methods/account_setAccountTTL.md b/old_docs/API_docs_v25/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v25/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v25/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_setPassword.md b/old_docs/API_docs_v25/methods/account_setPassword.md index 377ccaef..6dda13c7 100644 --- a/old_docs/API_docs_v25/methods/account_setPassword.md +++ b/old_docs/API_docs_v25/methods/account_setPassword.md @@ -11,12 +11,12 @@ Set 2FA password ### 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\_salt|[bytes](../types/bytes.md) | Yes|New salt| -|new\_password\_hash|[bytes](../types/bytes.md) | Yes|`hash('sha256', $new_salt.$new_password.$new_salt, true)`| -|hint|[string](../types/string.md) | Yes|Hint| +| 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\_salt|[bytes](../types/bytes.md) | New salt | Yes| +|new\_password\_hash|[bytes](../types/bytes.md) | `hash('sha256', $new_salt.$new_password.$new_salt, true)` | Yes| +|hint|[string](../types/string.md) | Hint | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/account_setPrivacy.md b/old_docs/API_docs_v25/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v25/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v25/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_unregisterDevice.md b/old_docs/API_docs_v25/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v25/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v25/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v25/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_updateNotifySettings.md b/old_docs/API_docs_v25/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v25/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v25/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_updateProfile.md b/old_docs/API_docs_v25/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v25/methods/account_updateProfile.md +++ b/old_docs/API_docs_v25/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v25/methods/account_updateStatus.md b/old_docs/API_docs_v25/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v25/methods/account_updateStatus.md +++ b/old_docs/API_docs_v25/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/account_updateUsername.md b/old_docs/API_docs_v25/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v25/methods/account_updateUsername.md +++ b/old_docs/API_docs_v25/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/auth_checkPhone.md b/old_docs/API_docs_v25/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v25/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v25/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v25/methods/auth_sendCall.md b/old_docs/API_docs_v25/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v25/methods/auth_sendCall.md +++ b/old_docs/API_docs_v25/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/auth_sendInvites.md b/old_docs/API_docs_v25/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v25/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v25/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/auth_sendSms.md b/old_docs/API_docs_v25/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v25/methods/auth_sendSms.md +++ b/old_docs/API_docs_v25/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/contacts_block.md b/old_docs/API_docs_v25/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v25/methods/contacts_block.md +++ b/old_docs/API_docs_v25/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/contacts_deleteContact.md b/old_docs/API_docs_v25/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v25/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v25/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/contacts_deleteContacts.md b/old_docs/API_docs_v25/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v25/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v25/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/contacts_getBlocked.md b/old_docs/API_docs_v25/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v25/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v25/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/contacts_getContacts.md b/old_docs/API_docs_v25/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v25/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v25/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v25/methods/contacts_getSuggested.md b/old_docs/API_docs_v25/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v25/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v25/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v25/methods/contacts_importCard.md b/old_docs/API_docs_v25/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v25/methods/contacts_importCard.md +++ b/old_docs/API_docs_v25/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/contacts_importContacts.md b/old_docs/API_docs_v25/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v25/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v25/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v25/methods/contacts_search.md b/old_docs/API_docs_v25/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v25/methods/contacts_search.md +++ b/old_docs/API_docs_v25/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/contacts_unblock.md b/old_docs/API_docs_v25/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v25/methods/contacts_unblock.md +++ b/old_docs/API_docs_v25/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/geochats_checkin.md b/old_docs/API_docs_v25/methods/geochats_checkin.md index 67ca47f3..c1909467 100644 --- a/old_docs/API_docs_v25/methods/geochats_checkin.md +++ b/old_docs/API_docs_v25/methods/geochats_checkin.md @@ -11,9 +11,9 @@ Join a geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_createGeoChat.md b/old_docs/API_docs_v25/methods/geochats_createGeoChat.md index fa93cda5..4781b50d 100644 --- a/old_docs/API_docs_v25/methods/geochats_createGeoChat.md +++ b/old_docs/API_docs_v25/methods/geochats_createGeoChat.md @@ -11,12 +11,12 @@ Create geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Geochat title| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| -|address|[string](../types/string.md) | Yes|Geochat address| -|venue|[string](../types/string.md) | Yes|Geochat venue | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|title|[string](../types/string.md) | Geochat title | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geochat location | Optional| +|address|[string](../types/string.md) | Geochat address | Yes| +|venue|[string](../types/string.md) | Geochat venue | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md b/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md index 71b2d06a..296b220a 100644 --- a/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md +++ b/old_docs/API_docs_v25/methods/geochats_editChatPhoto.md @@ -11,10 +11,10 @@ Edit geochat photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new photo | Optional| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_editChatTitle.md b/old_docs/API_docs_v25/methods/geochats_editChatTitle.md index 534128b6..f8cff88d 100644 --- a/old_docs/API_docs_v25/methods/geochats_editChatTitle.md +++ b/old_docs/API_docs_v25/methods/geochats_editChatTitle.md @@ -11,11 +11,11 @@ Edit geochat title ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|title|[string](../types/string.md) | Yes|The new title| -|address|[string](../types/string.md) | Yes|The new address| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|title|[string](../types/string.md) | The new title | Yes| +|address|[string](../types/string.md) | The new address | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getFullChat.md b/old_docs/API_docs_v25/methods/geochats_getFullChat.md index 992e5767..fa3baeb0 100644 --- a/old_docs/API_docs_v25/methods/geochats_getFullChat.md +++ b/old_docs/API_docs_v25/methods/geochats_getFullChat.md @@ -11,9 +11,9 @@ Get full info about a geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| ### Return type: [messages\_ChatFull](../types/messages_ChatFull.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getHistory.md b/old_docs/API_docs_v25/methods/geochats_getHistory.md index 5cb935f7..30f78447 100644 --- a/old_docs/API_docs_v25/methods/geochats_getHistory.md +++ b/old_docs/API_docs_v25/methods/geochats_getHistory.md @@ -11,12 +11,12 @@ Get geochat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getLocated.md b/old_docs/API_docs_v25/methods/geochats_getLocated.md index 023e401e..8f9bf461 100644 --- a/old_docs/API_docs_v25/methods/geochats_getLocated.md +++ b/old_docs/API_docs_v25/methods/geochats_getLocated.md @@ -11,11 +11,11 @@ Get nearby geochats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| -|radius|[int](../types/int.md) | Yes|Radius| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Current location | Optional| +|radius|[int](../types/int.md) | Radius | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Located](../types/geochats_Located.md) diff --git a/old_docs/API_docs_v25/methods/geochats_getRecents.md b/old_docs/API_docs_v25/methods/geochats_getRecents.md index b9ad6ab9..7c8fbc31 100644 --- a/old_docs/API_docs_v25/methods/geochats_getRecents.md +++ b/old_docs/API_docs_v25/methods/geochats_getRecents.md @@ -11,10 +11,10 @@ Get recent geochats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v25/methods/geochats_search.md b/old_docs/API_docs_v25/methods/geochats_search.md index 4e13631a..927f0849 100644 --- a/old_docs/API_docs_v25/methods/geochats_search.md +++ b/old_docs/API_docs_v25/methods/geochats_search.md @@ -11,16 +11,16 @@ Search messages in geocha ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|q|[string](../types/string.md) | Yes|The search query| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date| -|max\_date|[int](../types/int.md) | Yes|Maximum date| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|q|[string](../types/string.md) | The search query | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Search filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date | Yes| +|max\_date|[int](../types/int.md) | Maximum date | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v25/methods/geochats_sendMedia.md b/old_docs/API_docs_v25/methods/geochats_sendMedia.md index 1643a851..5fd1a158 100644 --- a/old_docs/API_docs_v25/methods/geochats_sendMedia.md +++ b/old_docs/API_docs_v25/methods/geochats_sendMedia.md @@ -11,10 +11,10 @@ Send media to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_sendMessage.md b/old_docs/API_docs_v25/methods/geochats_sendMessage.md index 653ab880..85de20d8 100644 --- a/old_docs/API_docs_v25/methods/geochats_sendMessage.md +++ b/old_docs/API_docs_v25/methods/geochats_sendMessage.md @@ -11,10 +11,10 @@ Send message to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|message|[string](../types/string.md) | Yes|The message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|message|[string](../types/string.md) | The message | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/geochats_setTyping.md b/old_docs/API_docs_v25/methods/geochats_setTyping.md index 7b692abf..fb709484 100644 --- a/old_docs/API_docs_v25/methods/geochats_setTyping.md +++ b/old_docs/API_docs_v25/methods/geochats_setTyping.md @@ -11,10 +11,10 @@ Send typing notification to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|typing|[Bool](../types/Bool.md) | Yes|Typing or not typing| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|typing|[Bool](../types/Bool.md) | Typing or not typing | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/help_getAppUpdate.md b/old_docs/API_docs_v25/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v25/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v25/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v25/methods/help_getInviteText.md b/old_docs/API_docs_v25/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v25/methods/help_getInviteText.md +++ b/old_docs/API_docs_v25/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v25/methods/help_saveAppLog.md b/old_docs/API_docs_v25/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v25/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v25/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/initConnection.md b/old_docs/API_docs_v25/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v25/methods/initConnection.md +++ b/old_docs/API_docs_v25/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v25/methods/invokeAfterMsg.md b/old_docs/API_docs_v25/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v25/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v25/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/invokeAfterMsgs.md b/old_docs/API_docs_v25/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v25/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v25/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/invokeWithLayer.md b/old_docs/API_docs_v25/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v25/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v25/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v25/methods/messages_addChatUser.md b/old_docs/API_docs_v25/methods/messages_addChatUser.md index f25db775..07f88f50 100644 --- a/old_docs/API_docs_v25/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v25/methods/messages_addChatUser.md @@ -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: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_createChat.md b/old_docs/API_docs_v25/methods/messages_createChat.md index 8a9c9c21..801a3c7e 100644 --- a/old_docs/API_docs_v25/methods/messages_createChat.md +++ b/old_docs/API_docs_v25/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_deleteChatUser.md b/old_docs/API_docs_v25/methods/messages_deleteChatUser.md index 4b355cfb..6a3db15d 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v25/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_deleteHistory.md b/old_docs/API_docs_v25/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v25/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v25/methods/messages_deleteMessages.md b/old_docs/API_docs_v25/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v25/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v25/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v25/methods/messages_editChatPhoto.md b/old_docs/API_docs_v25/methods/messages_editChatPhoto.md index 11b913b3..a0564d0d 100644 --- a/old_docs/API_docs_v25/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v25/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_editChatTitle.md b/old_docs/API_docs_v25/methods/messages_editChatTitle.md index b9daa120..e51d4f1c 100644 --- a/old_docs/API_docs_v25/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v25/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_forwardMessage.md b/old_docs/API_docs_v25/methods/messages_forwardMessage.md index b6532853..5f1ec345 100644 --- a/old_docs/API_docs_v25/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v25/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_forwardMessages.md b/old_docs/API_docs_v25/methods/messages_forwardMessages.md index 0cc322d0..1c990900 100644 --- a/old_docs/API_docs_v25/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v25/methods/messages_forwardMessages.md @@ -11,10 +11,10 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [int](../types/int.md) | Yes|The message IDs| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) diff --git a/old_docs/API_docs_v25/methods/messages_getAllStickers.md b/old_docs/API_docs_v25/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v25/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v25/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v25/methods/messages_getChats.md b/old_docs/API_docs_v25/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v25/methods/messages_getChats.md +++ b/old_docs/API_docs_v25/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v25/methods/messages_getDialogs.md b/old_docs/API_docs_v25/methods/messages_getDialogs.md index 8606087d..c93f1d1c 100644 --- a/old_docs/API_docs_v25/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v25/methods/messages_getDialogs.md @@ -11,11 +11,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of result to return | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v25/methods/messages_getHistory.md b/old_docs/API_docs_v25/methods/messages_getHistory.md index 52f56819..f8240098 100644 --- a/old_docs/API_docs_v25/methods/messages_getHistory.md +++ b/old_docs/API_docs_v25/methods/messages_getHistory.md @@ -11,12 +11,12 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[int](../types/int.md) | Yes|Message ID offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset|[int](../types/int.md) | Message ID offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v25/methods/messages_getMessages.md b/old_docs/API_docs_v25/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v25/methods/messages_getMessages.md +++ b/old_docs/API_docs_v25/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v25/methods/messages_getStickers.md b/old_docs/API_docs_v25/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v25/methods/messages_getStickers.md +++ b/old_docs/API_docs_v25/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v25/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/messages_readHistory.md b/old_docs/API_docs_v25/methods/messages_readHistory.md index a38ea73d..22f247bc 100644 --- a/old_docs/API_docs_v25/methods/messages_readHistory.md +++ b/old_docs/API_docs_v25/methods/messages_readHistory.md @@ -11,11 +11,11 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v25/methods/messages_readMessageContents.md b/old_docs/API_docs_v25/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v25/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v25/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v25/methods/messages_receivedMessages.md b/old_docs/API_docs_v25/methods/messages_receivedMessages.md index 032496e5..44dc6a71 100644 --- a/old_docs/API_docs_v25/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v25/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v25/methods/messages_search.md b/old_docs/API_docs_v25/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v25/methods/messages_search.md +++ b/old_docs/API_docs_v25/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendBroadcast.md b/old_docs/API_docs_v25/methods/messages_sendBroadcast.md index fedd6177..c77c6e1e 100644 --- a/old_docs/API_docs_v25/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v25/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendEncrypted.md b/old_docs/API_docs_v25/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v25/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_sendMedia.md b/old_docs/API_docs_v25/methods/messages_sendMedia.md index ae9bfcaf..b1e5ed90 100644 --- a/old_docs/API_docs_v25/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v25/methods/messages_sendMedia.md @@ -11,11 +11,11 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| ### Return type: [messages\_StatedMessage](../types/messages_StatedMessage.md) @@ -82,6 +82,7 @@ messages_StatedMessage = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v25/methods/messages_sendMessage.md b/old_docs/API_docs_v25/methods/messages_sendMessage.md index ceee587f..0c5a0626 100644 --- a/old_docs/API_docs_v25/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v25/methods/messages_sendMessage.md @@ -11,11 +11,11 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) diff --git a/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v25/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/messages_setTyping.md b/old_docs/API_docs_v25/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v25/methods/messages_setTyping.md +++ b/old_docs/API_docs_v25/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v25/methods/photos_deletePhotos.md b/old_docs/API_docs_v25/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v25/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v25/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v25/methods/photos_getUserPhotos.md b/old_docs/API_docs_v25/methods/photos_getUserPhotos.md index 83659b20..fef30862 100644 --- a/old_docs/API_docs_v25/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v25/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v25/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v25/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v25/methods/users_getUsers.md b/old_docs/API_docs_v25/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v25/methods/users_getUsers.md +++ b/old_docs/API_docs_v25/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v27/methods/account_changePhone.md b/old_docs/API_docs_v27/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v27/methods/account_changePhone.md +++ b/old_docs/API_docs_v27/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_checkUsername.md b/old_docs/API_docs_v27/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v27/methods/account_checkUsername.md +++ b/old_docs/API_docs_v27/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_deleteAccount.md b/old_docs/API_docs_v27/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v27/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v27/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_getNotifySettings.md b/old_docs/API_docs_v27/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v27/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v27/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_getPasswordSettings.md b/old_docs/API_docs_v27/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v27/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v27/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_getPrivacy.md b/old_docs/API_docs_v27/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v27/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v27/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_registerDevice.md b/old_docs/API_docs_v27/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v27/methods/account_registerDevice.md +++ b/old_docs/API_docs_v27/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/account_resetAuthorization.md b/old_docs/API_docs_v27/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v27/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v27/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v27/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v27/methods/account_setAccountTTL.md b/old_docs/API_docs_v27/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v27/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v27/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_setPrivacy.md b/old_docs/API_docs_v27/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v27/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v27/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_unregisterDevice.md b/old_docs/API_docs_v27/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v27/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v27/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v27/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_updateNotifySettings.md b/old_docs/API_docs_v27/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v27/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v27/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v27/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_updateProfile.md b/old_docs/API_docs_v27/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v27/methods/account_updateProfile.md +++ b/old_docs/API_docs_v27/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v27/methods/account_updateStatus.md b/old_docs/API_docs_v27/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v27/methods/account_updateStatus.md +++ b/old_docs/API_docs_v27/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/account_updateUsername.md b/old_docs/API_docs_v27/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v27/methods/account_updateUsername.md +++ b/old_docs/API_docs_v27/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/auth_checkPhone.md b/old_docs/API_docs_v27/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v27/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v27/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v27/methods/auth_recoverPassword.md b/old_docs/API_docs_v27/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v27/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v27/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/auth_sendCall.md b/old_docs/API_docs_v27/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v27/methods/auth_sendCall.md +++ b/old_docs/API_docs_v27/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/auth_sendInvites.md b/old_docs/API_docs_v27/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v27/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v27/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/auth_sendSms.md b/old_docs/API_docs_v27/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v27/methods/auth_sendSms.md +++ b/old_docs/API_docs_v27/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/contacts_block.md b/old_docs/API_docs_v27/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v27/methods/contacts_block.md +++ b/old_docs/API_docs_v27/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/contacts_deleteContact.md b/old_docs/API_docs_v27/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v27/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v27/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/contacts_deleteContacts.md b/old_docs/API_docs_v27/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v27/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v27/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/contacts_getBlocked.md b/old_docs/API_docs_v27/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v27/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v27/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/contacts_getContacts.md b/old_docs/API_docs_v27/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v27/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v27/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v27/methods/contacts_getSuggested.md b/old_docs/API_docs_v27/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v27/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v27/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v27/methods/contacts_importCard.md b/old_docs/API_docs_v27/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v27/methods/contacts_importCard.md +++ b/old_docs/API_docs_v27/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/contacts_importContacts.md b/old_docs/API_docs_v27/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v27/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v27/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v27/methods/contacts_search.md b/old_docs/API_docs_v27/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v27/methods/contacts_search.md +++ b/old_docs/API_docs_v27/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/contacts_unblock.md b/old_docs/API_docs_v27/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v27/methods/contacts_unblock.md +++ b/old_docs/API_docs_v27/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/geochats_checkin.md b/old_docs/API_docs_v27/methods/geochats_checkin.md index 67ca47f3..c1909467 100644 --- a/old_docs/API_docs_v27/methods/geochats_checkin.md +++ b/old_docs/API_docs_v27/methods/geochats_checkin.md @@ -11,9 +11,9 @@ Join a geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_createGeoChat.md b/old_docs/API_docs_v27/methods/geochats_createGeoChat.md index fa93cda5..4781b50d 100644 --- a/old_docs/API_docs_v27/methods/geochats_createGeoChat.md +++ b/old_docs/API_docs_v27/methods/geochats_createGeoChat.md @@ -11,12 +11,12 @@ Create geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Geochat title| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| -|address|[string](../types/string.md) | Yes|Geochat address| -|venue|[string](../types/string.md) | Yes|Geochat venue | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|title|[string](../types/string.md) | Geochat title | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geochat location | Optional| +|address|[string](../types/string.md) | Geochat address | Yes| +|venue|[string](../types/string.md) | Geochat venue | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md b/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md index 71b2d06a..296b220a 100644 --- a/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md +++ b/old_docs/API_docs_v27/methods/geochats_editChatPhoto.md @@ -11,10 +11,10 @@ Edit geochat photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new photo | Optional| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_editChatTitle.md b/old_docs/API_docs_v27/methods/geochats_editChatTitle.md index 534128b6..f8cff88d 100644 --- a/old_docs/API_docs_v27/methods/geochats_editChatTitle.md +++ b/old_docs/API_docs_v27/methods/geochats_editChatTitle.md @@ -11,11 +11,11 @@ Edit geochat title ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|title|[string](../types/string.md) | Yes|The new title| -|address|[string](../types/string.md) | Yes|The new address| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|title|[string](../types/string.md) | The new title | Yes| +|address|[string](../types/string.md) | The new address | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getFullChat.md b/old_docs/API_docs_v27/methods/geochats_getFullChat.md index 992e5767..fa3baeb0 100644 --- a/old_docs/API_docs_v27/methods/geochats_getFullChat.md +++ b/old_docs/API_docs_v27/methods/geochats_getFullChat.md @@ -11,9 +11,9 @@ Get full info about a geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| ### Return type: [messages\_ChatFull](../types/messages_ChatFull.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getHistory.md b/old_docs/API_docs_v27/methods/geochats_getHistory.md index 5cb935f7..30f78447 100644 --- a/old_docs/API_docs_v27/methods/geochats_getHistory.md +++ b/old_docs/API_docs_v27/methods/geochats_getHistory.md @@ -11,12 +11,12 @@ Get geochat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getLocated.md b/old_docs/API_docs_v27/methods/geochats_getLocated.md index 023e401e..8f9bf461 100644 --- a/old_docs/API_docs_v27/methods/geochats_getLocated.md +++ b/old_docs/API_docs_v27/methods/geochats_getLocated.md @@ -11,11 +11,11 @@ Get nearby geochats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| -|radius|[int](../types/int.md) | Yes|Radius| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Current location | Optional| +|radius|[int](../types/int.md) | Radius | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Located](../types/geochats_Located.md) diff --git a/old_docs/API_docs_v27/methods/geochats_getRecents.md b/old_docs/API_docs_v27/methods/geochats_getRecents.md index b9ad6ab9..7c8fbc31 100644 --- a/old_docs/API_docs_v27/methods/geochats_getRecents.md +++ b/old_docs/API_docs_v27/methods/geochats_getRecents.md @@ -11,10 +11,10 @@ Get recent geochats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v27/methods/geochats_search.md b/old_docs/API_docs_v27/methods/geochats_search.md index 4e13631a..927f0849 100644 --- a/old_docs/API_docs_v27/methods/geochats_search.md +++ b/old_docs/API_docs_v27/methods/geochats_search.md @@ -11,16 +11,16 @@ Search messages in geocha ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|q|[string](../types/string.md) | Yes|The search query| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date| -|max\_date|[int](../types/int.md) | Yes|Maximum date| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|q|[string](../types/string.md) | The search query | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Search filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date | Yes| +|max\_date|[int](../types/int.md) | Maximum date | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v27/methods/geochats_sendMedia.md b/old_docs/API_docs_v27/methods/geochats_sendMedia.md index 1643a851..5fd1a158 100644 --- a/old_docs/API_docs_v27/methods/geochats_sendMedia.md +++ b/old_docs/API_docs_v27/methods/geochats_sendMedia.md @@ -11,10 +11,10 @@ Send media to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_sendMessage.md b/old_docs/API_docs_v27/methods/geochats_sendMessage.md index 653ab880..85de20d8 100644 --- a/old_docs/API_docs_v27/methods/geochats_sendMessage.md +++ b/old_docs/API_docs_v27/methods/geochats_sendMessage.md @@ -11,10 +11,10 @@ Send message to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|message|[string](../types/string.md) | Yes|The message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|message|[string](../types/string.md) | The message | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v27/methods/geochats_setTyping.md b/old_docs/API_docs_v27/methods/geochats_setTyping.md index 7b692abf..fb709484 100644 --- a/old_docs/API_docs_v27/methods/geochats_setTyping.md +++ b/old_docs/API_docs_v27/methods/geochats_setTyping.md @@ -11,10 +11,10 @@ Send typing notification to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|typing|[Bool](../types/Bool.md) | Yes|Typing or not typing| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|typing|[Bool](../types/Bool.md) | Typing or not typing | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/help_getAppUpdate.md b/old_docs/API_docs_v27/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v27/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v27/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v27/methods/help_getInviteText.md b/old_docs/API_docs_v27/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v27/methods/help_getInviteText.md +++ b/old_docs/API_docs_v27/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v27/methods/help_saveAppLog.md b/old_docs/API_docs_v27/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v27/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v27/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/initConnection.md b/old_docs/API_docs_v27/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v27/methods/initConnection.md +++ b/old_docs/API_docs_v27/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v27/methods/invokeAfterMsg.md b/old_docs/API_docs_v27/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v27/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v27/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/invokeAfterMsgs.md b/old_docs/API_docs_v27/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v27/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v27/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/invokeWithLayer.md b/old_docs/API_docs_v27/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v27/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v27/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/messages_addChatUser.md b/old_docs/API_docs_v27/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v27/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v27/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v27/methods/messages_createChat.md b/old_docs/API_docs_v27/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v27/methods/messages_createChat.md +++ b/old_docs/API_docs_v27/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_deleteChatUser.md b/old_docs/API_docs_v27/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v27/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_deleteHistory.md b/old_docs/API_docs_v27/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v27/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v27/methods/messages_deleteMessages.md b/old_docs/API_docs_v27/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v27/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v27/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v27/methods/messages_editChatPhoto.md b/old_docs/API_docs_v27/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v27/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v27/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_editChatTitle.md b/old_docs/API_docs_v27/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v27/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v27/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_forwardMessage.md b/old_docs/API_docs_v27/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v27/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v27/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_forwardMessages.md b/old_docs/API_docs_v27/methods/messages_forwardMessages.md index 7d20b06b..13e1fed1 100644 --- a/old_docs/API_docs_v27/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v27/methods/messages_forwardMessages.md @@ -11,10 +11,10 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [int](../types/int.md) | Yes|The message IDs| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_getAllStickers.md b/old_docs/API_docs_v27/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v27/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v27/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v27/methods/messages_getChats.md b/old_docs/API_docs_v27/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v27/methods/messages_getChats.md +++ b/old_docs/API_docs_v27/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v27/methods/messages_getDialogs.md b/old_docs/API_docs_v27/methods/messages_getDialogs.md index 8606087d..c93f1d1c 100644 --- a/old_docs/API_docs_v27/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v27/methods/messages_getDialogs.md @@ -11,11 +11,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of result to return | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v27/methods/messages_getHistory.md b/old_docs/API_docs_v27/methods/messages_getHistory.md index 52f56819..f8240098 100644 --- a/old_docs/API_docs_v27/methods/messages_getHistory.md +++ b/old_docs/API_docs_v27/methods/messages_getHistory.md @@ -11,12 +11,12 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[int](../types/int.md) | Yes|Message ID offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset|[int](../types/int.md) | Message ID offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v27/methods/messages_getMessages.md b/old_docs/API_docs_v27/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v27/methods/messages_getMessages.md +++ b/old_docs/API_docs_v27/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v27/methods/messages_getStickers.md b/old_docs/API_docs_v27/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v27/methods/messages_getStickers.md +++ b/old_docs/API_docs_v27/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v27/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v27/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/messages_readHistory.md b/old_docs/API_docs_v27/methods/messages_readHistory.md index a38ea73d..22f247bc 100644 --- a/old_docs/API_docs_v27/methods/messages_readHistory.md +++ b/old_docs/API_docs_v27/methods/messages_readHistory.md @@ -11,11 +11,11 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v27/methods/messages_readMessageContents.md b/old_docs/API_docs_v27/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v27/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v27/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v27/methods/messages_receivedMessages.md b/old_docs/API_docs_v27/methods/messages_receivedMessages.md index 032496e5..44dc6a71 100644 --- a/old_docs/API_docs_v27/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v27/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v27/methods/messages_search.md b/old_docs/API_docs_v27/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v27/methods/messages_search.md +++ b/old_docs/API_docs_v27/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendBroadcast.md b/old_docs/API_docs_v27/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v27/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v27/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendEncrypted.md b/old_docs/API_docs_v27/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v27/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_sendMedia.md b/old_docs/API_docs_v27/methods/messages_sendMedia.md index 794bdf0c..5767e394 100644 --- a/old_docs/API_docs_v27/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v27/methods/messages_sendMedia.md @@ -11,11 +11,11 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -82,6 +82,7 @@ Updates = messages.sendMedia({peer=InputPeer, reply_to_msg_id=int, media=InputMe |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v27/methods/messages_sendMessage.md b/old_docs/API_docs_v27/methods/messages_sendMessage.md index 4ab2090a..aa220850 100644 --- a/old_docs/API_docs_v27/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v27/methods/messages_sendMessage.md @@ -11,11 +11,11 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) diff --git a/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v27/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/messages_setTyping.md b/old_docs/API_docs_v27/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v27/methods/messages_setTyping.md +++ b/old_docs/API_docs_v27/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v27/methods/photos_deletePhotos.md b/old_docs/API_docs_v27/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v27/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v27/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v27/methods/photos_getUserPhotos.md b/old_docs/API_docs_v27/methods/photos_getUserPhotos.md index 83659b20..fef30862 100644 --- a/old_docs/API_docs_v27/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v27/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v27/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v27/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v27/methods/users_getUsers.md b/old_docs/API_docs_v27/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v27/methods/users_getUsers.md +++ b/old_docs/API_docs_v27/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v33/methods/account_changePhone.md b/old_docs/API_docs_v33/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v33/methods/account_changePhone.md +++ b/old_docs/API_docs_v33/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_checkUsername.md b/old_docs/API_docs_v33/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v33/methods/account_checkUsername.md +++ b/old_docs/API_docs_v33/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_deleteAccount.md b/old_docs/API_docs_v33/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v33/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v33/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_getNotifySettings.md b/old_docs/API_docs_v33/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v33/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v33/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_getPasswordSettings.md b/old_docs/API_docs_v33/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v33/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v33/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_getPrivacy.md b/old_docs/API_docs_v33/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v33/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v33/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_registerDevice.md b/old_docs/API_docs_v33/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v33/methods/account_registerDevice.md +++ b/old_docs/API_docs_v33/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/account_resetAuthorization.md b/old_docs/API_docs_v33/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v33/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v33/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v33/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v33/methods/account_setAccountTTL.md b/old_docs/API_docs_v33/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v33/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v33/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_setPrivacy.md b/old_docs/API_docs_v33/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v33/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v33/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_unregisterDevice.md b/old_docs/API_docs_v33/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v33/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v33/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v33/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_updateNotifySettings.md b/old_docs/API_docs_v33/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v33/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v33/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v33/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_updateProfile.md b/old_docs/API_docs_v33/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v33/methods/account_updateProfile.md +++ b/old_docs/API_docs_v33/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v33/methods/account_updateStatus.md b/old_docs/API_docs_v33/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v33/methods/account_updateStatus.md +++ b/old_docs/API_docs_v33/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/account_updateUsername.md b/old_docs/API_docs_v33/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v33/methods/account_updateUsername.md +++ b/old_docs/API_docs_v33/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/auth_checkPhone.md b/old_docs/API_docs_v33/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v33/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v33/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v33/methods/auth_recoverPassword.md b/old_docs/API_docs_v33/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v33/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v33/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/auth_sendCall.md b/old_docs/API_docs_v33/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v33/methods/auth_sendCall.md +++ b/old_docs/API_docs_v33/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/auth_sendInvites.md b/old_docs/API_docs_v33/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v33/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v33/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/auth_sendSms.md b/old_docs/API_docs_v33/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v33/methods/auth_sendSms.md +++ b/old_docs/API_docs_v33/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/contacts_block.md b/old_docs/API_docs_v33/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v33/methods/contacts_block.md +++ b/old_docs/API_docs_v33/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/contacts_deleteContact.md b/old_docs/API_docs_v33/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v33/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v33/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/contacts_deleteContacts.md b/old_docs/API_docs_v33/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v33/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v33/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/contacts_getBlocked.md b/old_docs/API_docs_v33/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v33/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v33/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/contacts_getContacts.md b/old_docs/API_docs_v33/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v33/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v33/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v33/methods/contacts_getSuggested.md b/old_docs/API_docs_v33/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v33/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v33/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v33/methods/contacts_importCard.md b/old_docs/API_docs_v33/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v33/methods/contacts_importCard.md +++ b/old_docs/API_docs_v33/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/contacts_importContacts.md b/old_docs/API_docs_v33/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v33/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v33/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v33/methods/contacts_search.md b/old_docs/API_docs_v33/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v33/methods/contacts_search.md +++ b/old_docs/API_docs_v33/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/contacts_unblock.md b/old_docs/API_docs_v33/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v33/methods/contacts_unblock.md +++ b/old_docs/API_docs_v33/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/geochats_checkin.md b/old_docs/API_docs_v33/methods/geochats_checkin.md index 67ca47f3..c1909467 100644 --- a/old_docs/API_docs_v33/methods/geochats_checkin.md +++ b/old_docs/API_docs_v33/methods/geochats_checkin.md @@ -11,9 +11,9 @@ Join a geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_createGeoChat.md b/old_docs/API_docs_v33/methods/geochats_createGeoChat.md index fa93cda5..4781b50d 100644 --- a/old_docs/API_docs_v33/methods/geochats_createGeoChat.md +++ b/old_docs/API_docs_v33/methods/geochats_createGeoChat.md @@ -11,12 +11,12 @@ Create geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Geochat title| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Geochat location| -|address|[string](../types/string.md) | Yes|Geochat address| -|venue|[string](../types/string.md) | Yes|Geochat venue | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|title|[string](../types/string.md) | Geochat title | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Geochat location | Optional| +|address|[string](../types/string.md) | Geochat address | Yes| +|venue|[string](../types/string.md) | Geochat venue | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md b/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md index 71b2d06a..296b220a 100644 --- a/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md +++ b/old_docs/API_docs_v33/methods/geochats_editChatPhoto.md @@ -11,10 +11,10 @@ Edit geochat photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new photo | Optional| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_editChatTitle.md b/old_docs/API_docs_v33/methods/geochats_editChatTitle.md index 534128b6..f8cff88d 100644 --- a/old_docs/API_docs_v33/methods/geochats_editChatTitle.md +++ b/old_docs/API_docs_v33/methods/geochats_editChatTitle.md @@ -11,11 +11,11 @@ Edit geochat title ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|title|[string](../types/string.md) | Yes|The new title| -|address|[string](../types/string.md) | Yes|The new address| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|title|[string](../types/string.md) | The new title | Yes| +|address|[string](../types/string.md) | The new address | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getFullChat.md b/old_docs/API_docs_v33/methods/geochats_getFullChat.md index 992e5767..fa3baeb0 100644 --- a/old_docs/API_docs_v33/methods/geochats_getFullChat.md +++ b/old_docs/API_docs_v33/methods/geochats_getFullChat.md @@ -11,9 +11,9 @@ Get full info about a geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| ### Return type: [messages\_ChatFull](../types/messages_ChatFull.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getHistory.md b/old_docs/API_docs_v33/methods/geochats_getHistory.md index 5cb935f7..30f78447 100644 --- a/old_docs/API_docs_v33/methods/geochats_getHistory.md +++ b/old_docs/API_docs_v33/methods/geochats_getHistory.md @@ -11,12 +11,12 @@ Get geochat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getLocated.md b/old_docs/API_docs_v33/methods/geochats_getLocated.md index 023e401e..8f9bf461 100644 --- a/old_docs/API_docs_v33/methods/geochats_getLocated.md +++ b/old_docs/API_docs_v33/methods/geochats_getLocated.md @@ -11,11 +11,11 @@ Get nearby geochats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Current location| -|radius|[int](../types/int.md) | Yes|Radius| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Current location | Optional| +|radius|[int](../types/int.md) | Radius | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Located](../types/geochats_Located.md) diff --git a/old_docs/API_docs_v33/methods/geochats_getRecents.md b/old_docs/API_docs_v33/methods/geochats_getRecents.md index b9ad6ab9..7c8fbc31 100644 --- a/old_docs/API_docs_v33/methods/geochats_getRecents.md +++ b/old_docs/API_docs_v33/methods/geochats_getRecents.md @@ -11,10 +11,10 @@ Get recent geochats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v33/methods/geochats_search.md b/old_docs/API_docs_v33/methods/geochats_search.md index 4e13631a..927f0849 100644 --- a/old_docs/API_docs_v33/methods/geochats_search.md +++ b/old_docs/API_docs_v33/methods/geochats_search.md @@ -11,16 +11,16 @@ Search messages in geocha ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|q|[string](../types/string.md) | Yes|The search query| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Search filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date| -|max\_date|[int](../types/int.md) | Yes|Maximum date| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|q|[string](../types/string.md) | The search query | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Search filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date | Yes| +|max\_date|[int](../types/int.md) | Maximum date | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [geochats\_Messages](../types/geochats_Messages.md) diff --git a/old_docs/API_docs_v33/methods/geochats_sendMedia.md b/old_docs/API_docs_v33/methods/geochats_sendMedia.md index 1643a851..5fd1a158 100644 --- a/old_docs/API_docs_v33/methods/geochats_sendMedia.md +++ b/old_docs/API_docs_v33/methods/geochats_sendMedia.md @@ -11,10 +11,10 @@ Send media to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_sendMessage.md b/old_docs/API_docs_v33/methods/geochats_sendMessage.md index 653ab880..85de20d8 100644 --- a/old_docs/API_docs_v33/methods/geochats_sendMessage.md +++ b/old_docs/API_docs_v33/methods/geochats_sendMessage.md @@ -11,10 +11,10 @@ Send message to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|message|[string](../types/string.md) | Yes|The message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|message|[string](../types/string.md) | The message | Yes| ### Return type: [geochats\_StatedMessage](../types/geochats_StatedMessage.md) diff --git a/old_docs/API_docs_v33/methods/geochats_setTyping.md b/old_docs/API_docs_v33/methods/geochats_setTyping.md index 7b692abf..fb709484 100644 --- a/old_docs/API_docs_v33/methods/geochats_setTyping.md +++ b/old_docs/API_docs_v33/methods/geochats_setTyping.md @@ -11,10 +11,10 @@ Send typing notification to geochat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputGeoChat](../types/InputGeoChat.md) | Yes|The geochat| -|typing|[Bool](../types/Bool.md) | Yes|Typing or not typing| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputGeoChat](../types/InputGeoChat.md) | The geochat | Yes| +|typing|[Bool](../types/Bool.md) | Typing or not typing | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/help_getAppChangelog.md b/old_docs/API_docs_v33/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v33/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v33/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v33/methods/help_getAppUpdate.md b/old_docs/API_docs_v33/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v33/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v33/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v33/methods/help_getInviteText.md b/old_docs/API_docs_v33/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v33/methods/help_getInviteText.md +++ b/old_docs/API_docs_v33/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v33/methods/help_saveAppLog.md b/old_docs/API_docs_v33/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v33/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v33/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/initConnection.md b/old_docs/API_docs_v33/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v33/methods/initConnection.md +++ b/old_docs/API_docs_v33/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v33/methods/invokeAfterMsg.md b/old_docs/API_docs_v33/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v33/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v33/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/invokeAfterMsgs.md b/old_docs/API_docs_v33/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v33/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v33/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/invokeWithLayer.md b/old_docs/API_docs_v33/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v33/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v33/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v33/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/messages_addChatUser.md b/old_docs/API_docs_v33/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v33/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v33/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v33/methods/messages_checkChatInvite.md b/old_docs/API_docs_v33/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v33/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v33/methods/messages_createChat.md b/old_docs/API_docs_v33/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v33/methods/messages_createChat.md +++ b/old_docs/API_docs_v33/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_deleteChatUser.md b/old_docs/API_docs_v33/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v33/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_deleteHistory.md b/old_docs/API_docs_v33/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v33/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v33/methods/messages_deleteMessages.md b/old_docs/API_docs_v33/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v33/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v33/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v33/methods/messages_editChatPhoto.md b/old_docs/API_docs_v33/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v33/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v33/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_editChatTitle.md b/old_docs/API_docs_v33/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v33/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v33/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_exportChatInvite.md b/old_docs/API_docs_v33/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v33/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v33/methods/messages_forwardMessage.md b/old_docs/API_docs_v33/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v33/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v33/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_forwardMessages.md b/old_docs/API_docs_v33/methods/messages_forwardMessages.md index 7d20b06b..13e1fed1 100644 --- a/old_docs/API_docs_v33/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v33/methods/messages_forwardMessages.md @@ -11,10 +11,10 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [int](../types/int.md) | Yes|The message IDs| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_getAllStickers.md b/old_docs/API_docs_v33/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v33/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v33/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v33/methods/messages_getChats.md b/old_docs/API_docs_v33/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v33/methods/messages_getChats.md +++ b/old_docs/API_docs_v33/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v33/methods/messages_getDialogs.md b/old_docs/API_docs_v33/methods/messages_getDialogs.md index 8606087d..c93f1d1c 100644 --- a/old_docs/API_docs_v33/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v33/methods/messages_getDialogs.md @@ -11,11 +11,11 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum ID of result to return | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v33/methods/messages_getHistory.md b/old_docs/API_docs_v33/methods/messages_getHistory.md index 52f56819..f8240098 100644 --- a/old_docs/API_docs_v33/methods/messages_getHistory.md +++ b/old_docs/API_docs_v33/methods/messages_getHistory.md @@ -11,12 +11,12 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[int](../types/int.md) | Yes|Message ID offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset|[int](../types/int.md) | Message ID offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v33/methods/messages_getMessages.md b/old_docs/API_docs_v33/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v33/methods/messages_getMessages.md +++ b/old_docs/API_docs_v33/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v33/methods/messages_getStickerSet.md b/old_docs/API_docs_v33/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v33/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v33/methods/messages_getStickers.md b/old_docs/API_docs_v33/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v33/methods/messages_getStickers.md +++ b/old_docs/API_docs_v33/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v33/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v33/methods/messages_importChatInvite.md b/old_docs/API_docs_v33/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v33/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v33/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_installStickerSet.md b/old_docs/API_docs_v33/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v33/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v33/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_readHistory.md b/old_docs/API_docs_v33/methods/messages_readHistory.md index a38ea73d..22f247bc 100644 --- a/old_docs/API_docs_v33/methods/messages_readHistory.md +++ b/old_docs/API_docs_v33/methods/messages_readHistory.md @@ -11,11 +11,11 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v33/methods/messages_readMessageContents.md b/old_docs/API_docs_v33/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v33/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v33/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v33/methods/messages_receivedMessages.md b/old_docs/API_docs_v33/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v33/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v33/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_search.md b/old_docs/API_docs_v33/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v33/methods/messages_search.md +++ b/old_docs/API_docs_v33/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendBroadcast.md b/old_docs/API_docs_v33/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v33/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v33/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendEncrypted.md b/old_docs/API_docs_v33/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v33/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_sendMedia.md b/old_docs/API_docs_v33/methods/messages_sendMedia.md index 08513d39..0b1180e8 100644 --- a/old_docs/API_docs_v33/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v33/methods/messages_sendMedia.md @@ -11,12 +11,12 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -91,6 +91,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v33/methods/messages_sendMessage.md b/old_docs/API_docs_v33/methods/messages_sendMessage.md index 4693b085..95d39434 100644 --- a/old_docs/API_docs_v33/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v33/methods/messages_sendMessage.md @@ -11,12 +11,12 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [messages\_SentMessage](../types/messages_SentMessage.md) diff --git a/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v33/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_setTyping.md b/old_docs/API_docs_v33/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v33/methods/messages_setTyping.md +++ b/old_docs/API_docs_v33/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/messages_startBot.md b/old_docs/API_docs_v33/methods/messages_startBot.md index cb2a7b03..79d18a42 100644 --- a/old_docs/API_docs_v33/methods/messages_startBot.md +++ b/old_docs/API_docs_v33/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Chat ID| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat ID | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v33/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v33/methods/photos_deletePhotos.md b/old_docs/API_docs_v33/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v33/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v33/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v33/methods/photos_getUserPhotos.md b/old_docs/API_docs_v33/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v33/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v33/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v33/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v33/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v33/methods/users_getUsers.md b/old_docs/API_docs_v33/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v33/methods/users_getUsers.md +++ b/old_docs/API_docs_v33/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v38/methods/account_changePhone.md b/old_docs/API_docs_v38/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v38/methods/account_changePhone.md +++ b/old_docs/API_docs_v38/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_checkUsername.md b/old_docs/API_docs_v38/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v38/methods/account_checkUsername.md +++ b/old_docs/API_docs_v38/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_deleteAccount.md b/old_docs/API_docs_v38/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v38/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v38/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_getNotifySettings.md b/old_docs/API_docs_v38/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v38/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v38/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_getPasswordSettings.md b/old_docs/API_docs_v38/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v38/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v38/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_getPrivacy.md b/old_docs/API_docs_v38/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v38/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v38/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_registerDevice.md b/old_docs/API_docs_v38/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v38/methods/account_registerDevice.md +++ b/old_docs/API_docs_v38/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/account_resetAuthorization.md b/old_docs/API_docs_v38/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v38/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v38/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v38/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v38/methods/account_setAccountTTL.md b/old_docs/API_docs_v38/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v38/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v38/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_setPrivacy.md b/old_docs/API_docs_v38/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v38/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v38/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_unregisterDevice.md b/old_docs/API_docs_v38/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v38/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v38/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v38/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_updateNotifySettings.md b/old_docs/API_docs_v38/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v38/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v38/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v38/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_updateProfile.md b/old_docs/API_docs_v38/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v38/methods/account_updateProfile.md +++ b/old_docs/API_docs_v38/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v38/methods/account_updateStatus.md b/old_docs/API_docs_v38/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v38/methods/account_updateStatus.md +++ b/old_docs/API_docs_v38/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/account_updateUsername.md b/old_docs/API_docs_v38/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v38/methods/account_updateUsername.md +++ b/old_docs/API_docs_v38/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/auth_checkPhone.md b/old_docs/API_docs_v38/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v38/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v38/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v38/methods/auth_recoverPassword.md b/old_docs/API_docs_v38/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v38/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v38/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/auth_sendCall.md b/old_docs/API_docs_v38/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v38/methods/auth_sendCall.md +++ b/old_docs/API_docs_v38/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/auth_sendInvites.md b/old_docs/API_docs_v38/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v38/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v38/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/auth_sendSms.md b/old_docs/API_docs_v38/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v38/methods/auth_sendSms.md +++ b/old_docs/API_docs_v38/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_checkUsername.md b/old_docs/API_docs_v38/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v38/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v38/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_createChannel.md b/old_docs/API_docs_v38/methods/channels_createChannel.md index 2b934d46..31491a21 100644 --- a/old_docs/API_docs_v38/methods/channels_createChannel.md +++ b/old_docs/API_docs_v38/methods/channels_createChannel.md @@ -11,11 +11,11 @@ Create channel/supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Supergroup/channel title| -|about|[string](../types/string.md) | Yes|About text| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|Users to add to channel| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|title|[string](../types/string.md) | Supergroup/channel title | Yes| +|about|[string](../types/string.md) | About text | Yes| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Users to add to channel | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_deleteChannel.md b/old_docs/API_docs_v38/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v38/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_deleteMessages.md b/old_docs/API_docs_v38/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v38/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v38/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_editAbout.md b/old_docs/API_docs_v38/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v38/methods/channels_editAbout.md +++ b/old_docs/API_docs_v38/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_editAdmin.md b/old_docs/API_docs_v38/methods/channels_editAdmin.md index f95f86e0..63bc3b26 100644 --- a/old_docs/API_docs_v38/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v38/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/channels_editPhoto.md b/old_docs/API_docs_v38/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v38/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v38/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_editTitle.md b/old_docs/API_docs_v38/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v38/methods/channels_editTitle.md +++ b/old_docs/API_docs_v38/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_exportInvite.md b/old_docs/API_docs_v38/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v38/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v38/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_getChannels.md b/old_docs/API_docs_v38/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v38/methods/channels_getChannels.md +++ b/old_docs/API_docs_v38/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_getDialogs.md b/old_docs/API_docs_v38/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v38/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v38/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v38/methods/channels_getImportantHistory.md b/old_docs/API_docs_v38/methods/channels_getImportantHistory.md index c74a35b8..e038bde8 100644 --- a/old_docs/API_docs_v38/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v38/methods/channels_getImportantHistory.md @@ -11,14 +11,14 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/channels_getMessages.md b/old_docs/API_docs_v38/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v38/methods/channels_getMessages.md +++ b/old_docs/API_docs_v38/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/channels_getParticipant.md b/old_docs/API_docs_v38/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v38/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v38/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_getParticipants.md b/old_docs/API_docs_v38/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v38/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v38/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v38/methods/channels_inviteToChannel.md b/old_docs/API_docs_v38/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v38/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v38/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_joinChannel.md b/old_docs/API_docs_v38/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v38/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v38/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_kickFromChannel.md b/old_docs/API_docs_v38/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v38/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v38/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_leaveChannel.md b/old_docs/API_docs_v38/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v38/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v38/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_readHistory.md b/old_docs/API_docs_v38/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v38/methods/channels_readHistory.md +++ b/old_docs/API_docs_v38/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_reportSpam.md b/old_docs/API_docs_v38/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v38/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v38/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/channels_toggleComments.md b/old_docs/API_docs_v38/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v38/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v38/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/channels_updateUsername.md b/old_docs/API_docs_v38/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v38/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v38/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_block.md b/old_docs/API_docs_v38/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v38/methods/contacts_block.md +++ b/old_docs/API_docs_v38/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_deleteContact.md b/old_docs/API_docs_v38/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v38/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v38/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_deleteContacts.md b/old_docs/API_docs_v38/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v38/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v38/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_getBlocked.md b/old_docs/API_docs_v38/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v38/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v38/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_getContacts.md b/old_docs/API_docs_v38/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v38/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v38/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v38/methods/contacts_getSuggested.md b/old_docs/API_docs_v38/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v38/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v38/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v38/methods/contacts_importCard.md b/old_docs/API_docs_v38/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v38/methods/contacts_importCard.md +++ b/old_docs/API_docs_v38/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_importContacts.md b/old_docs/API_docs_v38/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v38/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v38/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v38/methods/contacts_search.md b/old_docs/API_docs_v38/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v38/methods/contacts_search.md +++ b/old_docs/API_docs_v38/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/contacts_unblock.md b/old_docs/API_docs_v38/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v38/methods/contacts_unblock.md +++ b/old_docs/API_docs_v38/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/help_getAppChangelog.md b/old_docs/API_docs_v38/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v38/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v38/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v38/methods/help_getAppUpdate.md b/old_docs/API_docs_v38/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v38/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v38/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v38/methods/help_getInviteText.md b/old_docs/API_docs_v38/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v38/methods/help_getInviteText.md +++ b/old_docs/API_docs_v38/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v38/methods/help_saveAppLog.md b/old_docs/API_docs_v38/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v38/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v38/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/initConnection.md b/old_docs/API_docs_v38/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v38/methods/initConnection.md +++ b/old_docs/API_docs_v38/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v38/methods/invokeAfterMsg.md b/old_docs/API_docs_v38/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v38/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v38/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/invokeAfterMsgs.md b/old_docs/API_docs_v38/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v38/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v38/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/invokeWithLayer.md b/old_docs/API_docs_v38/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v38/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v38/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v38/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/messages_addChatUser.md b/old_docs/API_docs_v38/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v38/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v38/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v38/methods/messages_checkChatInvite.md b/old_docs/API_docs_v38/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v38/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v38/methods/messages_createChat.md b/old_docs/API_docs_v38/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v38/methods/messages_createChat.md +++ b/old_docs/API_docs_v38/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_deleteChatUser.md b/old_docs/API_docs_v38/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v38/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_deleteHistory.md b/old_docs/API_docs_v38/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v38/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v38/methods/messages_deleteMessages.md b/old_docs/API_docs_v38/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v38/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v38/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v38/methods/messages_editChatPhoto.md b/old_docs/API_docs_v38/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v38/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v38/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_editChatTitle.md b/old_docs/API_docs_v38/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v38/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v38/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_exportChatInvite.md b/old_docs/API_docs_v38/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v38/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v38/methods/messages_forwardMessage.md b/old_docs/API_docs_v38/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v38/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v38/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_forwardMessages.md b/old_docs/API_docs_v38/methods/messages_forwardMessages.md index 39461f95..0ba67a6f 100644 --- a/old_docs/API_docs_v38/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v38/methods/messages_forwardMessages.md @@ -11,11 +11,11 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_getAllStickers.md b/old_docs/API_docs_v38/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v38/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v38/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v38/methods/messages_getChats.md b/old_docs/API_docs_v38/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v38/methods/messages_getChats.md +++ b/old_docs/API_docs_v38/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v38/methods/messages_getDialogs.md b/old_docs/API_docs_v38/methods/messages_getDialogs.md index c47f99d0..d3992fed 100644 --- a/old_docs/API_docs_v38/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v38/methods/messages_getDialogs.md @@ -11,10 +11,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v38/methods/messages_getHistory.md b/old_docs/API_docs_v38/methods/messages_getHistory.md index 0cbbcdc0..955f71cf 100644 --- a/old_docs/API_docs_v38/methods/messages_getHistory.md +++ b/old_docs/API_docs_v38/methods/messages_getHistory.md @@ -11,14 +11,14 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/messages_getMessages.md b/old_docs/API_docs_v38/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v38/methods/messages_getMessages.md +++ b/old_docs/API_docs_v38/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/messages_getMessagesViews.md b/old_docs/API_docs_v38/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v38/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v38/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v38/methods/messages_getStickerSet.md b/old_docs/API_docs_v38/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v38/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v38/methods/messages_getStickers.md b/old_docs/API_docs_v38/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v38/methods/messages_getStickers.md +++ b/old_docs/API_docs_v38/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v38/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v38/methods/messages_importChatInvite.md b/old_docs/API_docs_v38/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v38/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v38/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_installStickerSet.md b/old_docs/API_docs_v38/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v38/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v38/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_readHistory.md b/old_docs/API_docs_v38/methods/messages_readHistory.md index a38ea73d..22f247bc 100644 --- a/old_docs/API_docs_v38/methods/messages_readHistory.md +++ b/old_docs/API_docs_v38/methods/messages_readHistory.md @@ -11,11 +11,11 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v38/methods/messages_readMessageContents.md b/old_docs/API_docs_v38/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v38/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v38/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v38/methods/messages_receivedMessages.md b/old_docs/API_docs_v38/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v38/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v38/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_reportSpam.md b/old_docs/API_docs_v38/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v38/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v38/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_search.md b/old_docs/API_docs_v38/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v38/methods/messages_search.md +++ b/old_docs/API_docs_v38/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendBroadcast.md b/old_docs/API_docs_v38/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v38/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v38/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendEncrypted.md b/old_docs/API_docs_v38/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v38/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v38/methods/messages_sendMedia.md b/old_docs/API_docs_v38/methods/messages_sendMedia.md index 08513d39..0b1180e8 100644 --- a/old_docs/API_docs_v38/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v38/methods/messages_sendMedia.md @@ -11,12 +11,12 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -91,6 +91,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v38/methods/messages_sendMessage.md b/old_docs/API_docs_v38/methods/messages_sendMessage.md index aa241de8..e10bd256 100644 --- a/old_docs/API_docs_v38/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v38/methods/messages_sendMessage.md @@ -11,13 +11,13 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v38/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_setTyping.md b/old_docs/API_docs_v38/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v38/methods/messages_setTyping.md +++ b/old_docs/API_docs_v38/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/messages_startBot.md b/old_docs/API_docs_v38/methods/messages_startBot.md index cb2a7b03..79d18a42 100644 --- a/old_docs/API_docs_v38/methods/messages_startBot.md +++ b/old_docs/API_docs_v38/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Chat ID| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat ID | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v38/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v38/methods/photos_deletePhotos.md b/old_docs/API_docs_v38/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v38/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v38/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v38/methods/photos_getUserPhotos.md b/old_docs/API_docs_v38/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v38/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v38/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v38/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v38/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v38/methods/users_getUsers.md b/old_docs/API_docs_v38/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v38/methods/users_getUsers.md +++ b/old_docs/API_docs_v38/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v40/methods/account_changePhone.md b/old_docs/API_docs_v40/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v40/methods/account_changePhone.md +++ b/old_docs/API_docs_v40/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_checkUsername.md b/old_docs/API_docs_v40/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v40/methods/account_checkUsername.md +++ b/old_docs/API_docs_v40/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_deleteAccount.md b/old_docs/API_docs_v40/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v40/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v40/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_getNotifySettings.md b/old_docs/API_docs_v40/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v40/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v40/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_getPasswordSettings.md b/old_docs/API_docs_v40/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v40/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v40/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_getPrivacy.md b/old_docs/API_docs_v40/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v40/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v40/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_registerDevice.md b/old_docs/API_docs_v40/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v40/methods/account_registerDevice.md +++ b/old_docs/API_docs_v40/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/account_resetAuthorization.md b/old_docs/API_docs_v40/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v40/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v40/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v40/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v40/methods/account_setAccountTTL.md b/old_docs/API_docs_v40/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v40/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v40/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_setPrivacy.md b/old_docs/API_docs_v40/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v40/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v40/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_unregisterDevice.md b/old_docs/API_docs_v40/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v40/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v40/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v40/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_updateNotifySettings.md b/old_docs/API_docs_v40/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v40/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v40/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v40/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_updateProfile.md b/old_docs/API_docs_v40/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v40/methods/account_updateProfile.md +++ b/old_docs/API_docs_v40/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v40/methods/account_updateStatus.md b/old_docs/API_docs_v40/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v40/methods/account_updateStatus.md +++ b/old_docs/API_docs_v40/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/account_updateUsername.md b/old_docs/API_docs_v40/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v40/methods/account_updateUsername.md +++ b/old_docs/API_docs_v40/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/auth_checkPhone.md b/old_docs/API_docs_v40/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v40/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v40/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v40/methods/auth_recoverPassword.md b/old_docs/API_docs_v40/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v40/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v40/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/auth_sendCall.md b/old_docs/API_docs_v40/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v40/methods/auth_sendCall.md +++ b/old_docs/API_docs_v40/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/auth_sendInvites.md b/old_docs/API_docs_v40/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v40/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v40/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/auth_sendSms.md b/old_docs/API_docs_v40/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v40/methods/auth_sendSms.md +++ b/old_docs/API_docs_v40/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/contacts_block.md b/old_docs/API_docs_v40/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v40/methods/contacts_block.md +++ b/old_docs/API_docs_v40/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/contacts_deleteContact.md b/old_docs/API_docs_v40/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v40/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v40/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/contacts_deleteContacts.md b/old_docs/API_docs_v40/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v40/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v40/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/contacts_getBlocked.md b/old_docs/API_docs_v40/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v40/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v40/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/contacts_getContacts.md b/old_docs/API_docs_v40/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v40/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v40/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v40/methods/contacts_getSuggested.md b/old_docs/API_docs_v40/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v40/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v40/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v40/methods/contacts_importCard.md b/old_docs/API_docs_v40/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v40/methods/contacts_importCard.md +++ b/old_docs/API_docs_v40/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/contacts_importContacts.md b/old_docs/API_docs_v40/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v40/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v40/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v40/methods/contacts_search.md b/old_docs/API_docs_v40/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v40/methods/contacts_search.md +++ b/old_docs/API_docs_v40/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/contacts_unblock.md b/old_docs/API_docs_v40/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v40/methods/contacts_unblock.md +++ b/old_docs/API_docs_v40/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/help_getAppChangelog.md b/old_docs/API_docs_v40/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v40/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v40/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v40/methods/help_getAppUpdate.md b/old_docs/API_docs_v40/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v40/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v40/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v40/methods/help_getInviteText.md b/old_docs/API_docs_v40/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v40/methods/help_getInviteText.md +++ b/old_docs/API_docs_v40/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v40/methods/help_saveAppLog.md b/old_docs/API_docs_v40/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v40/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v40/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/initConnection.md b/old_docs/API_docs_v40/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v40/methods/initConnection.md +++ b/old_docs/API_docs_v40/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v40/methods/invokeAfterMsg.md b/old_docs/API_docs_v40/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v40/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v40/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/invokeAfterMsgs.md b/old_docs/API_docs_v40/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v40/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v40/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/invokeWithLayer.md b/old_docs/API_docs_v40/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v40/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v40/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v40/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/messages_addChatUser.md b/old_docs/API_docs_v40/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v40/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v40/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v40/methods/messages_checkChatInvite.md b/old_docs/API_docs_v40/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v40/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v40/methods/messages_createChannel.md b/old_docs/API_docs_v40/methods/messages_createChannel.md index 24d2ef99..d6f59f7f 100644 --- a/old_docs/API_docs_v40/methods/messages_createChannel.md +++ b/old_docs/API_docs_v40/methods/messages_createChannel.md @@ -11,9 +11,9 @@ Create channel ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|title|[string](../types/string.md) | Yes|Channel/supergroup title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|title|[string](../types/string.md) | Channel/supergroup title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_createChat.md b/old_docs/API_docs_v40/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v40/methods/messages_createChat.md +++ b/old_docs/API_docs_v40/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md b/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md index 8f056fa1..ae9f592c 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md +++ b/old_docs/API_docs_v40/methods/messages_deleteChannelMessages.md @@ -11,10 +11,10 @@ Delete channel messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The channel/supergroup| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.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) diff --git a/old_docs/API_docs_v40/methods/messages_deleteChatUser.md b/old_docs/API_docs_v40/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v40/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_deleteHistory.md b/old_docs/API_docs_v40/methods/messages_deleteHistory.md index a8820678..5f04ad57 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v40/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v40/methods/messages_deleteMessages.md b/old_docs/API_docs_v40/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v40/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v40/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v40/methods/messages_editChatPhoto.md b/old_docs/API_docs_v40/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v40/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v40/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_editChatTitle.md b/old_docs/API_docs_v40/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v40/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v40/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_exportChatInvite.md b/old_docs/API_docs_v40/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v40/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v40/methods/messages_forwardMessage.md b/old_docs/API_docs_v40/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v40/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v40/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_forwardMessages.md b/old_docs/API_docs_v40/methods/messages_forwardMessages.md index 7d20b06b..13e1fed1 100644 --- a/old_docs/API_docs_v40/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v40/methods/messages_forwardMessages.md @@ -11,10 +11,10 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|id|Array of [int](../types/int.md) | Yes|The message IDs| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_getAllStickers.md b/old_docs/API_docs_v40/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v40/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v40/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md b/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md index 296ef495..ebdfb574 100644 --- a/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md +++ b/old_docs/API_docs_v40/methods/messages_getChannelDialogs.md @@ -11,10 +11,10 @@ Get channel/supergruop dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v40/methods/messages_getChats.md b/old_docs/API_docs_v40/methods/messages_getChats.md index 28d9c0a7..696c3e53 100644 --- a/old_docs/API_docs_v40/methods/messages_getChats.md +++ b/old_docs/API_docs_v40/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [InputChat](../types/InputChat.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [InputChat](../types/InputChat.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v40/methods/messages_getDialogs.md b/old_docs/API_docs_v40/methods/messages_getDialogs.md index c47f99d0..d3992fed 100644 --- a/old_docs/API_docs_v40/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v40/methods/messages_getDialogs.md @@ -11,10 +11,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v40/methods/messages_getHistory.md b/old_docs/API_docs_v40/methods/messages_getHistory.md index 2e2e58b6..d21484f5 100644 --- a/old_docs/API_docs_v40/methods/messages_getHistory.md +++ b/old_docs/API_docs_v40/methods/messages_getHistory.md @@ -11,13 +11,13 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset|[int](../types/int.md) | Yes|Message ID offset| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset|[int](../types/int.md) | Message ID offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v40/methods/messages_getImportantHistory.md b/old_docs/API_docs_v40/methods/messages_getImportantHistory.md index 1a85a242..97ef4d44 100644 --- a/old_docs/API_docs_v40/methods/messages_getImportantHistory.md +++ b/old_docs/API_docs_v40/methods/messages_getImportantHistory.md @@ -11,12 +11,12 @@ Get important message history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Peer| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Peer | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v40/methods/messages_getMessages.md b/old_docs/API_docs_v40/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v40/methods/messages_getMessages.md +++ b/old_docs/API_docs_v40/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v40/methods/messages_getStickerSet.md b/old_docs/API_docs_v40/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v40/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v40/methods/messages_getStickers.md b/old_docs/API_docs_v40/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v40/methods/messages_getStickers.md +++ b/old_docs/API_docs_v40/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v40/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v40/methods/messages_importChatInvite.md b/old_docs/API_docs_v40/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v40/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v40/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_installStickerSet.md b/old_docs/API_docs_v40/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v40/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_readChannelHistory.md b/old_docs/API_docs_v40/methods/messages_readChannelHistory.md index 1663877e..135466be 100644 --- a/old_docs/API_docs_v40/methods/messages_readChannelHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readChannelHistory.md @@ -11,10 +11,10 @@ Mark channel/supergroup history as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The channel/supergruop| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The channel/supergruop | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_readHistory.md b/old_docs/API_docs_v40/methods/messages_readHistory.md index a38ea73d..22f247bc 100644 --- a/old_docs/API_docs_v40/methods/messages_readHistory.md +++ b/old_docs/API_docs_v40/methods/messages_readHistory.md @@ -11,11 +11,11 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| -|offset|[int](../types/int.md) | Yes|Offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| +|offset|[int](../types/int.md) | Offset | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v40/methods/messages_readMessageContents.md b/old_docs/API_docs_v40/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v40/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v40/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v40/methods/messages_receivedMessages.md b/old_docs/API_docs_v40/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v40/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v40/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_search.md b/old_docs/API_docs_v40/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v40/methods/messages_search.md +++ b/old_docs/API_docs_v40/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendBroadcast.md b/old_docs/API_docs_v40/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v40/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v40/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendEncrypted.md b/old_docs/API_docs_v40/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v40/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v40/methods/messages_sendMedia.md b/old_docs/API_docs_v40/methods/messages_sendMedia.md index 08513d39..0b1180e8 100644 --- a/old_docs/API_docs_v40/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v40/methods/messages_sendMedia.md @@ -11,12 +11,12 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -91,6 +91,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v40/methods/messages_sendMessage.md b/old_docs/API_docs_v40/methods/messages_sendMessage.md index aa241de8..e10bd256 100644 --- a/old_docs/API_docs_v40/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v40/methods/messages_sendMessage.md @@ -11,13 +11,13 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v40/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_setTyping.md b/old_docs/API_docs_v40/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v40/methods/messages_setTyping.md +++ b/old_docs/API_docs_v40/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/messages_startBot.md b/old_docs/API_docs_v40/methods/messages_startBot.md index cb2a7b03..79d18a42 100644 --- a/old_docs/API_docs_v40/methods/messages_startBot.md +++ b/old_docs/API_docs_v40/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Chat ID| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat ID | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v40/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v40/methods/photos_deletePhotos.md b/old_docs/API_docs_v40/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v40/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v40/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v40/methods/photos_getUserPhotos.md b/old_docs/API_docs_v40/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v40/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v40/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v40/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v40/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v40/methods/users_getUsers.md b/old_docs/API_docs_v40/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v40/methods/users_getUsers.md +++ b/old_docs/API_docs_v40/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v41/methods/account_changePhone.md b/old_docs/API_docs_v41/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v41/methods/account_changePhone.md +++ b/old_docs/API_docs_v41/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_checkUsername.md b/old_docs/API_docs_v41/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v41/methods/account_checkUsername.md +++ b/old_docs/API_docs_v41/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_deleteAccount.md b/old_docs/API_docs_v41/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v41/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v41/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_getNotifySettings.md b/old_docs/API_docs_v41/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v41/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v41/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_getPasswordSettings.md b/old_docs/API_docs_v41/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v41/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v41/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_getPrivacy.md b/old_docs/API_docs_v41/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v41/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v41/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_registerDevice.md b/old_docs/API_docs_v41/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v41/methods/account_registerDevice.md +++ b/old_docs/API_docs_v41/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/account_resetAuthorization.md b/old_docs/API_docs_v41/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v41/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v41/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v41/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v41/methods/account_setAccountTTL.md b/old_docs/API_docs_v41/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v41/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v41/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_setPrivacy.md b/old_docs/API_docs_v41/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v41/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v41/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_unregisterDevice.md b/old_docs/API_docs_v41/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v41/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v41/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v41/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_updateNotifySettings.md b/old_docs/API_docs_v41/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v41/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v41/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v41/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_updateProfile.md b/old_docs/API_docs_v41/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v41/methods/account_updateProfile.md +++ b/old_docs/API_docs_v41/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v41/methods/account_updateStatus.md b/old_docs/API_docs_v41/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v41/methods/account_updateStatus.md +++ b/old_docs/API_docs_v41/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/account_updateUsername.md b/old_docs/API_docs_v41/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v41/methods/account_updateUsername.md +++ b/old_docs/API_docs_v41/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/auth_checkPhone.md b/old_docs/API_docs_v41/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v41/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v41/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v41/methods/auth_recoverPassword.md b/old_docs/API_docs_v41/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v41/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v41/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/auth_sendCall.md b/old_docs/API_docs_v41/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v41/methods/auth_sendCall.md +++ b/old_docs/API_docs_v41/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/auth_sendInvites.md b/old_docs/API_docs_v41/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v41/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v41/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/auth_sendSms.md b/old_docs/API_docs_v41/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v41/methods/auth_sendSms.md +++ b/old_docs/API_docs_v41/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_checkUsername.md b/old_docs/API_docs_v41/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v41/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v41/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_createChannel.md b/old_docs/API_docs_v41/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v41/methods/channels_createChannel.md +++ b/old_docs/API_docs_v41/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_deleteChannel.md b/old_docs/API_docs_v41/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v41/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_deleteMessages.md b/old_docs/API_docs_v41/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v41/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v41/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_editAbout.md b/old_docs/API_docs_v41/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v41/methods/channels_editAbout.md +++ b/old_docs/API_docs_v41/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_editAdmin.md b/old_docs/API_docs_v41/methods/channels_editAdmin.md index f95f86e0..63bc3b26 100644 --- a/old_docs/API_docs_v41/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v41/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/channels_editPhoto.md b/old_docs/API_docs_v41/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v41/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v41/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_editTitle.md b/old_docs/API_docs_v41/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v41/methods/channels_editTitle.md +++ b/old_docs/API_docs_v41/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_exportInvite.md b/old_docs/API_docs_v41/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v41/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v41/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_getChannels.md b/old_docs/API_docs_v41/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v41/methods/channels_getChannels.md +++ b/old_docs/API_docs_v41/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_getDialogs.md b/old_docs/API_docs_v41/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v41/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v41/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v41/methods/channels_getImportantHistory.md b/old_docs/API_docs_v41/methods/channels_getImportantHistory.md index c74a35b8..e038bde8 100644 --- a/old_docs/API_docs_v41/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v41/methods/channels_getImportantHistory.md @@ -11,14 +11,14 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/channels_getMessages.md b/old_docs/API_docs_v41/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v41/methods/channels_getMessages.md +++ b/old_docs/API_docs_v41/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/channels_getParticipant.md b/old_docs/API_docs_v41/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v41/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v41/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_getParticipants.md b/old_docs/API_docs_v41/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v41/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v41/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v41/methods/channels_inviteToChannel.md b/old_docs/API_docs_v41/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v41/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v41/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_joinChannel.md b/old_docs/API_docs_v41/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v41/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v41/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_kickFromChannel.md b/old_docs/API_docs_v41/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v41/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v41/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_leaveChannel.md b/old_docs/API_docs_v41/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v41/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v41/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_readHistory.md b/old_docs/API_docs_v41/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v41/methods/channels_readHistory.md +++ b/old_docs/API_docs_v41/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_reportSpam.md b/old_docs/API_docs_v41/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v41/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v41/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/channels_toggleComments.md b/old_docs/API_docs_v41/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v41/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v41/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/channels_updateUsername.md b/old_docs/API_docs_v41/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v41/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v41/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_block.md b/old_docs/API_docs_v41/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v41/methods/contacts_block.md +++ b/old_docs/API_docs_v41/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_deleteContact.md b/old_docs/API_docs_v41/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v41/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v41/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_deleteContacts.md b/old_docs/API_docs_v41/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v41/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v41/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_getBlocked.md b/old_docs/API_docs_v41/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v41/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v41/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_getContacts.md b/old_docs/API_docs_v41/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v41/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v41/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v41/methods/contacts_getSuggested.md b/old_docs/API_docs_v41/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v41/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v41/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v41/methods/contacts_importCard.md b/old_docs/API_docs_v41/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v41/methods/contacts_importCard.md +++ b/old_docs/API_docs_v41/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_importContacts.md b/old_docs/API_docs_v41/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v41/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v41/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v41/methods/contacts_search.md b/old_docs/API_docs_v41/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v41/methods/contacts_search.md +++ b/old_docs/API_docs_v41/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/contacts_unblock.md b/old_docs/API_docs_v41/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v41/methods/contacts_unblock.md +++ b/old_docs/API_docs_v41/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/help_getAppChangelog.md b/old_docs/API_docs_v41/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v41/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v41/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v41/methods/help_getAppUpdate.md b/old_docs/API_docs_v41/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v41/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v41/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v41/methods/help_getInviteText.md b/old_docs/API_docs_v41/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v41/methods/help_getInviteText.md +++ b/old_docs/API_docs_v41/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v41/methods/help_saveAppLog.md b/old_docs/API_docs_v41/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v41/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v41/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/initConnection.md b/old_docs/API_docs_v41/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v41/methods/initConnection.md +++ b/old_docs/API_docs_v41/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v41/methods/invokeAfterMsg.md b/old_docs/API_docs_v41/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v41/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v41/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/invokeAfterMsgs.md b/old_docs/API_docs_v41/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v41/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v41/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/invokeWithLayer.md b/old_docs/API_docs_v41/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v41/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v41/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v41/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/messages_addChatUser.md b/old_docs/API_docs_v41/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v41/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v41/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v41/methods/messages_checkChatInvite.md b/old_docs/API_docs_v41/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v41/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v41/methods/messages_createChat.md b/old_docs/API_docs_v41/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v41/methods/messages_createChat.md +++ b/old_docs/API_docs_v41/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_deactivateChat.md b/old_docs/API_docs_v41/methods/messages_deactivateChat.md index f46c861f..910f2bee 100644 --- a/old_docs/API_docs_v41/methods/messages_deactivateChat.md +++ b/old_docs/API_docs_v41/methods/messages_deactivateChat.md @@ -11,10 +11,10 @@ Deactivate chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to deactivate| -|enabled|[Bool](../types/Bool.md) | Yes|Activate or deactivate?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to deactivate | Optional| +|enabled|[Bool](../types/Bool.md) | Activate or deactivate? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_deleteChatUser.md b/old_docs/API_docs_v41/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v41/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_deleteHistory.md b/old_docs/API_docs_v41/methods/messages_deleteHistory.md index 666b0989..4b00d3a2 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v41/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v41/methods/messages_deleteMessages.md b/old_docs/API_docs_v41/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v41/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v41/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v41/methods/messages_editChatAdmin.md b/old_docs/API_docs_v41/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v41/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_editChatPhoto.md b/old_docs/API_docs_v41/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v41/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_editChatTitle.md b/old_docs/API_docs_v41/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v41/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v41/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_exportChatInvite.md b/old_docs/API_docs_v41/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v41/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v41/methods/messages_forwardMessage.md b/old_docs/API_docs_v41/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v41/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v41/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_forwardMessages.md b/old_docs/API_docs_v41/methods/messages_forwardMessages.md index a00e3df4..1bc42a02 100644 --- a/old_docs/API_docs_v41/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v41/methods/messages_forwardMessages.md @@ -11,12 +11,12 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_getAllStickers.md b/old_docs/API_docs_v41/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v41/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v41/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v41/methods/messages_getChats.md b/old_docs/API_docs_v41/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v41/methods/messages_getChats.md +++ b/old_docs/API_docs_v41/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v41/methods/messages_getDialogs.md b/old_docs/API_docs_v41/methods/messages_getDialogs.md index c47f99d0..d3992fed 100644 --- a/old_docs/API_docs_v41/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v41/methods/messages_getDialogs.md @@ -11,10 +11,10 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v41/methods/messages_getHistory.md b/old_docs/API_docs_v41/methods/messages_getHistory.md index 0cbbcdc0..955f71cf 100644 --- a/old_docs/API_docs_v41/methods/messages_getHistory.md +++ b/old_docs/API_docs_v41/methods/messages_getHistory.md @@ -11,14 +11,14 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/messages_getMessages.md b/old_docs/API_docs_v41/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v41/methods/messages_getMessages.md +++ b/old_docs/API_docs_v41/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/messages_getMessagesViews.md b/old_docs/API_docs_v41/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v41/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v41/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v41/methods/messages_getStickerSet.md b/old_docs/API_docs_v41/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v41/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v41/methods/messages_getStickers.md b/old_docs/API_docs_v41/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v41/methods/messages_getStickers.md +++ b/old_docs/API_docs_v41/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v41/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v41/methods/messages_importChatInvite.md b/old_docs/API_docs_v41/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v41/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v41/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_installStickerSet.md b/old_docs/API_docs_v41/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v41/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_migrateChat.md b/old_docs/API_docs_v41/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v41/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v41/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v41/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_readHistory.md b/old_docs/API_docs_v41/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v41/methods/messages_readHistory.md +++ b/old_docs/API_docs_v41/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v41/methods/messages_readMessageContents.md b/old_docs/API_docs_v41/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v41/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v41/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v41/methods/messages_receivedMessages.md b/old_docs/API_docs_v41/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v41/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v41/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_reportSpam.md b/old_docs/API_docs_v41/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v41/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v41/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_search.md b/old_docs/API_docs_v41/methods/messages_search.md index abb3c9f8..519c76f9 100644 --- a/old_docs/API_docs_v41/methods/messages_search.md +++ b/old_docs/API_docs_v41/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/messages_searchGlobal.md b/old_docs/API_docs_v41/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v41/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v41/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendBroadcast.md b/old_docs/API_docs_v41/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v41/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v41/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendEncrypted.md b/old_docs/API_docs_v41/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v41/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v41/methods/messages_sendMedia.md b/old_docs/API_docs_v41/methods/messages_sendMedia.md index dd91995c..5b315147 100644 --- a/old_docs/API_docs_v41/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v41/methods/messages_sendMedia.md @@ -11,13 +11,13 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -94,6 +94,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v41/methods/messages_sendMessage.md b/old_docs/API_docs_v41/methods/messages_sendMessage.md index fba1d624..8f8ddb48 100644 --- a/old_docs/API_docs_v41/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v41/methods/messages_sendMessage.md @@ -11,15 +11,15 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v41/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_setTyping.md b/old_docs/API_docs_v41/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v41/methods/messages_setTyping.md +++ b/old_docs/API_docs_v41/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/messages_startBot.md b/old_docs/API_docs_v41/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v41/methods/messages_startBot.md +++ b/old_docs/API_docs_v41/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v41/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v41/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v41/methods/photos_deletePhotos.md b/old_docs/API_docs_v41/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v41/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v41/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v41/methods/photos_getUserPhotos.md b/old_docs/API_docs_v41/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v41/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v41/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v41/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v41/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v41/methods/users_getUsers.md b/old_docs/API_docs_v41/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v41/methods/users_getUsers.md +++ b/old_docs/API_docs_v41/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v42/methods/account_changePhone.md b/old_docs/API_docs_v42/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v42/methods/account_changePhone.md +++ b/old_docs/API_docs_v42/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_checkUsername.md b/old_docs/API_docs_v42/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v42/methods/account_checkUsername.md +++ b/old_docs/API_docs_v42/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_deleteAccount.md b/old_docs/API_docs_v42/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v42/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v42/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_getNotifySettings.md b/old_docs/API_docs_v42/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v42/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v42/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_getPasswordSettings.md b/old_docs/API_docs_v42/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v42/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v42/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_getPrivacy.md b/old_docs/API_docs_v42/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v42/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v42/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_registerDevice.md b/old_docs/API_docs_v42/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v42/methods/account_registerDevice.md +++ b/old_docs/API_docs_v42/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/account_resetAuthorization.md b/old_docs/API_docs_v42/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v42/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v42/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v42/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v42/methods/account_setAccountTTL.md b/old_docs/API_docs_v42/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v42/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v42/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_setPrivacy.md b/old_docs/API_docs_v42/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v42/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v42/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_unregisterDevice.md b/old_docs/API_docs_v42/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v42/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v42/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v42/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_updateNotifySettings.md b/old_docs/API_docs_v42/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v42/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v42/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v42/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_updateProfile.md b/old_docs/API_docs_v42/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v42/methods/account_updateProfile.md +++ b/old_docs/API_docs_v42/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v42/methods/account_updateStatus.md b/old_docs/API_docs_v42/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v42/methods/account_updateStatus.md +++ b/old_docs/API_docs_v42/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/account_updateUsername.md b/old_docs/API_docs_v42/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v42/methods/account_updateUsername.md +++ b/old_docs/API_docs_v42/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/auth_checkPhone.md b/old_docs/API_docs_v42/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v42/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v42/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v42/methods/auth_recoverPassword.md b/old_docs/API_docs_v42/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v42/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v42/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/auth_sendCall.md b/old_docs/API_docs_v42/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v42/methods/auth_sendCall.md +++ b/old_docs/API_docs_v42/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/auth_sendInvites.md b/old_docs/API_docs_v42/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v42/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v42/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/auth_sendSms.md b/old_docs/API_docs_v42/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v42/methods/auth_sendSms.md +++ b/old_docs/API_docs_v42/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/channels_checkUsername.md b/old_docs/API_docs_v42/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v42/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v42/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_createChannel.md b/old_docs/API_docs_v42/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v42/methods/channels_createChannel.md +++ b/old_docs/API_docs_v42/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_deleteChannel.md b/old_docs/API_docs_v42/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v42/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_deleteMessages.md b/old_docs/API_docs_v42/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v42/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v42/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_editAbout.md b/old_docs/API_docs_v42/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v42/methods/channels_editAbout.md +++ b/old_docs/API_docs_v42/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_editAdmin.md b/old_docs/API_docs_v42/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v42/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v42/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_editPhoto.md b/old_docs/API_docs_v42/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v42/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v42/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_editTitle.md b/old_docs/API_docs_v42/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v42/methods/channels_editTitle.md +++ b/old_docs/API_docs_v42/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_exportInvite.md b/old_docs/API_docs_v42/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v42/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v42/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_getChannels.md b/old_docs/API_docs_v42/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v42/methods/channels_getChannels.md +++ b/old_docs/API_docs_v42/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_getDialogs.md b/old_docs/API_docs_v42/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v42/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v42/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v42/methods/channels_getImportantHistory.md b/old_docs/API_docs_v42/methods/channels_getImportantHistory.md index c74a35b8..e038bde8 100644 --- a/old_docs/API_docs_v42/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v42/methods/channels_getImportantHistory.md @@ -11,14 +11,14 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/channels_getMessages.md b/old_docs/API_docs_v42/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v42/methods/channels_getMessages.md +++ b/old_docs/API_docs_v42/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/channels_getParticipant.md b/old_docs/API_docs_v42/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v42/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v42/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_getParticipants.md b/old_docs/API_docs_v42/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v42/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v42/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v42/methods/channels_inviteToChannel.md b/old_docs/API_docs_v42/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v42/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v42/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_joinChannel.md b/old_docs/API_docs_v42/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v42/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v42/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_kickFromChannel.md b/old_docs/API_docs_v42/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v42/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v42/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_leaveChannel.md b/old_docs/API_docs_v42/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v42/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v42/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_readHistory.md b/old_docs/API_docs_v42/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v42/methods/channels_readHistory.md +++ b/old_docs/API_docs_v42/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_reportSpam.md b/old_docs/API_docs_v42/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v42/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v42/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/channels_toggleComments.md b/old_docs/API_docs_v42/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v42/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v42/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/channels_updateUsername.md b/old_docs/API_docs_v42/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v42/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v42/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_block.md b/old_docs/API_docs_v42/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v42/methods/contacts_block.md +++ b/old_docs/API_docs_v42/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_deleteContact.md b/old_docs/API_docs_v42/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v42/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v42/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_deleteContacts.md b/old_docs/API_docs_v42/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v42/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v42/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_getBlocked.md b/old_docs/API_docs_v42/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v42/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v42/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_getContacts.md b/old_docs/API_docs_v42/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v42/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v42/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v42/methods/contacts_getSuggested.md b/old_docs/API_docs_v42/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v42/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v42/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v42/methods/contacts_importCard.md b/old_docs/API_docs_v42/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v42/methods/contacts_importCard.md +++ b/old_docs/API_docs_v42/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_importContacts.md b/old_docs/API_docs_v42/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v42/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v42/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v42/methods/contacts_search.md b/old_docs/API_docs_v42/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v42/methods/contacts_search.md +++ b/old_docs/API_docs_v42/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/contacts_unblock.md b/old_docs/API_docs_v42/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v42/methods/contacts_unblock.md +++ b/old_docs/API_docs_v42/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/help_getAppChangelog.md b/old_docs/API_docs_v42/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v42/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v42/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v42/methods/help_getAppUpdate.md b/old_docs/API_docs_v42/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v42/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v42/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v42/methods/help_getInviteText.md b/old_docs/API_docs_v42/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v42/methods/help_getInviteText.md +++ b/old_docs/API_docs_v42/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v42/methods/help_saveAppLog.md b/old_docs/API_docs_v42/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v42/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v42/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/initConnection.md b/old_docs/API_docs_v42/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v42/methods/initConnection.md +++ b/old_docs/API_docs_v42/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v42/methods/invokeAfterMsg.md b/old_docs/API_docs_v42/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v42/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v42/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/invokeAfterMsgs.md b/old_docs/API_docs_v42/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v42/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v42/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/invokeWithLayer.md b/old_docs/API_docs_v42/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v42/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v42/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v42/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/messages_addChatUser.md b/old_docs/API_docs_v42/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v42/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v42/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v42/methods/messages_checkChatInvite.md b/old_docs/API_docs_v42/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v42/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v42/methods/messages_createChat.md b/old_docs/API_docs_v42/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v42/methods/messages_createChat.md +++ b/old_docs/API_docs_v42/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_deleteChatUser.md b/old_docs/API_docs_v42/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v42/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_deleteHistory.md b/old_docs/API_docs_v42/methods/messages_deleteHistory.md index 666b0989..4b00d3a2 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v42/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v42/methods/messages_deleteMessages.md b/old_docs/API_docs_v42/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v42/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v42/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v42/methods/messages_editChatAdmin.md b/old_docs/API_docs_v42/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v42/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_editChatPhoto.md b/old_docs/API_docs_v42/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v42/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_editChatTitle.md b/old_docs/API_docs_v42/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v42/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v42/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_exportChatInvite.md b/old_docs/API_docs_v42/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v42/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v42/methods/messages_forwardMessage.md b/old_docs/API_docs_v42/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v42/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v42/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_forwardMessages.md b/old_docs/API_docs_v42/methods/messages_forwardMessages.md index a00e3df4..1bc42a02 100644 --- a/old_docs/API_docs_v42/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v42/methods/messages_forwardMessages.md @@ -11,12 +11,12 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_getAllStickers.md b/old_docs/API_docs_v42/methods/messages_getAllStickers.md index a67d89cb..faa8eea2 100644 --- a/old_docs/API_docs_v42/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v42/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|Previously fetched stickers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | Previously fetched stickers | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v42/methods/messages_getChats.md b/old_docs/API_docs_v42/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v42/methods/messages_getChats.md +++ b/old_docs/API_docs_v42/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v42/methods/messages_getDialogs.md b/old_docs/API_docs_v42/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v42/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v42/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v42/methods/messages_getHistory.md b/old_docs/API_docs_v42/methods/messages_getHistory.md index 0cbbcdc0..955f71cf 100644 --- a/old_docs/API_docs_v42/methods/messages_getHistory.md +++ b/old_docs/API_docs_v42/methods/messages_getHistory.md @@ -11,14 +11,14 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/messages_getMessages.md b/old_docs/API_docs_v42/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v42/methods/messages_getMessages.md +++ b/old_docs/API_docs_v42/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/messages_getMessagesViews.md b/old_docs/API_docs_v42/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v42/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v42/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v42/methods/messages_getStickerSet.md b/old_docs/API_docs_v42/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v42/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v42/methods/messages_getStickers.md b/old_docs/API_docs_v42/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v42/methods/messages_getStickers.md +++ b/old_docs/API_docs_v42/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v42/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v42/methods/messages_importChatInvite.md b/old_docs/API_docs_v42/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v42/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v42/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_installStickerSet.md b/old_docs/API_docs_v42/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v42/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_migrateChat.md b/old_docs/API_docs_v42/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v42/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v42/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v42/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_readHistory.md b/old_docs/API_docs_v42/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v42/methods/messages_readHistory.md +++ b/old_docs/API_docs_v42/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v42/methods/messages_readMessageContents.md b/old_docs/API_docs_v42/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v42/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v42/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v42/methods/messages_receivedMessages.md b/old_docs/API_docs_v42/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v42/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v42/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_reportSpam.md b/old_docs/API_docs_v42/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v42/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v42/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_search.md b/old_docs/API_docs_v42/methods/messages_search.md index abb3c9f8..519c76f9 100644 --- a/old_docs/API_docs_v42/methods/messages_search.md +++ b/old_docs/API_docs_v42/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/messages_searchGlobal.md b/old_docs/API_docs_v42/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v42/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v42/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendBroadcast.md b/old_docs/API_docs_v42/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v42/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v42/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendEncrypted.md b/old_docs/API_docs_v42/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v42/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v42/methods/messages_sendMedia.md b/old_docs/API_docs_v42/methods/messages_sendMedia.md index dd91995c..5b315147 100644 --- a/old_docs/API_docs_v42/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v42/methods/messages_sendMedia.md @@ -11,13 +11,13 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -94,6 +94,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v42/methods/messages_sendMessage.md b/old_docs/API_docs_v42/methods/messages_sendMessage.md index fba1d624..8f8ddb48 100644 --- a/old_docs/API_docs_v42/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v42/methods/messages_sendMessage.md @@ -11,15 +11,15 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v42/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_setTyping.md b/old_docs/API_docs_v42/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v42/methods/messages_setTyping.md +++ b/old_docs/API_docs_v42/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/messages_startBot.md b/old_docs/API_docs_v42/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v42/methods/messages_startBot.md +++ b/old_docs/API_docs_v42/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v42/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v42/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v42/methods/photos_deletePhotos.md b/old_docs/API_docs_v42/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v42/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v42/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v42/methods/photos_getUserPhotos.md b/old_docs/API_docs_v42/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v42/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v42/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v42/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v42/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v42/methods/users_getUsers.md b/old_docs/API_docs_v42/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v42/methods/users_getUsers.md +++ b/old_docs/API_docs_v42/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v44/methods/account_changePhone.md b/old_docs/API_docs_v44/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v44/methods/account_changePhone.md +++ b/old_docs/API_docs_v44/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_checkUsername.md b/old_docs/API_docs_v44/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v44/methods/account_checkUsername.md +++ b/old_docs/API_docs_v44/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_deleteAccount.md b/old_docs/API_docs_v44/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v44/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v44/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_getNotifySettings.md b/old_docs/API_docs_v44/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v44/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_getPasswordSettings.md b/old_docs/API_docs_v44/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v44/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v44/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_getPrivacy.md b/old_docs/API_docs_v44/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v44/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v44/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_registerDevice.md b/old_docs/API_docs_v44/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v44/methods/account_registerDevice.md +++ b/old_docs/API_docs_v44/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/account_reportPeer.md b/old_docs/API_docs_v44/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v44/methods/account_reportPeer.md +++ b/old_docs/API_docs_v44/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_resetAuthorization.md b/old_docs/API_docs_v44/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v44/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v44/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v44/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v44/methods/account_setAccountTTL.md b/old_docs/API_docs_v44/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v44/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v44/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_setPrivacy.md b/old_docs/API_docs_v44/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v44/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v44/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_unregisterDevice.md b/old_docs/API_docs_v44/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v44/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v44/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v44/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_updateNotifySettings.md b/old_docs/API_docs_v44/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v44/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v44/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v44/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_updateProfile.md b/old_docs/API_docs_v44/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v44/methods/account_updateProfile.md +++ b/old_docs/API_docs_v44/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v44/methods/account_updateStatus.md b/old_docs/API_docs_v44/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v44/methods/account_updateStatus.md +++ b/old_docs/API_docs_v44/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/account_updateUsername.md b/old_docs/API_docs_v44/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v44/methods/account_updateUsername.md +++ b/old_docs/API_docs_v44/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/auth_checkPhone.md b/old_docs/API_docs_v44/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v44/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v44/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v44/methods/auth_recoverPassword.md b/old_docs/API_docs_v44/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v44/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v44/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/auth_sendCall.md b/old_docs/API_docs_v44/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v44/methods/auth_sendCall.md +++ b/old_docs/API_docs_v44/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/auth_sendInvites.md b/old_docs/API_docs_v44/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v44/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v44/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/auth_sendSms.md b/old_docs/API_docs_v44/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v44/methods/auth_sendSms.md +++ b/old_docs/API_docs_v44/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/channels_checkUsername.md b/old_docs/API_docs_v44/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v44/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v44/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_createChannel.md b/old_docs/API_docs_v44/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v44/methods/channels_createChannel.md +++ b/old_docs/API_docs_v44/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_deleteChannel.md b/old_docs/API_docs_v44/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v44/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_deleteMessages.md b/old_docs/API_docs_v44/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v44/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v44/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_editAbout.md b/old_docs/API_docs_v44/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v44/methods/channels_editAbout.md +++ b/old_docs/API_docs_v44/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_editAdmin.md b/old_docs/API_docs_v44/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v44/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v44/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_editPhoto.md b/old_docs/API_docs_v44/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v44/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v44/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_editTitle.md b/old_docs/API_docs_v44/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v44/methods/channels_editTitle.md +++ b/old_docs/API_docs_v44/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_exportInvite.md b/old_docs/API_docs_v44/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v44/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v44/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_getChannels.md b/old_docs/API_docs_v44/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v44/methods/channels_getChannels.md +++ b/old_docs/API_docs_v44/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_getDialogs.md b/old_docs/API_docs_v44/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v44/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v44/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v44/methods/channels_getImportantHistory.md b/old_docs/API_docs_v44/methods/channels_getImportantHistory.md index c74a35b8..e038bde8 100644 --- a/old_docs/API_docs_v44/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v44/methods/channels_getImportantHistory.md @@ -11,14 +11,14 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/channels_getMessages.md b/old_docs/API_docs_v44/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v44/methods/channels_getMessages.md +++ b/old_docs/API_docs_v44/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/channels_getParticipant.md b/old_docs/API_docs_v44/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v44/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v44/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_getParticipants.md b/old_docs/API_docs_v44/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v44/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v44/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v44/methods/channels_inviteToChannel.md b/old_docs/API_docs_v44/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v44/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v44/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_joinChannel.md b/old_docs/API_docs_v44/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v44/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v44/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_kickFromChannel.md b/old_docs/API_docs_v44/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v44/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v44/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_leaveChannel.md b/old_docs/API_docs_v44/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v44/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v44/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_readHistory.md b/old_docs/API_docs_v44/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v44/methods/channels_readHistory.md +++ b/old_docs/API_docs_v44/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_reportSpam.md b/old_docs/API_docs_v44/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v44/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v44/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/channels_toggleComments.md b/old_docs/API_docs_v44/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v44/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v44/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/channels_updateUsername.md b/old_docs/API_docs_v44/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v44/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v44/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_block.md b/old_docs/API_docs_v44/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v44/methods/contacts_block.md +++ b/old_docs/API_docs_v44/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_deleteContact.md b/old_docs/API_docs_v44/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v44/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v44/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_deleteContacts.md b/old_docs/API_docs_v44/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v44/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v44/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_getBlocked.md b/old_docs/API_docs_v44/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v44/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v44/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_getContacts.md b/old_docs/API_docs_v44/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v44/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v44/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v44/methods/contacts_getSuggested.md b/old_docs/API_docs_v44/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v44/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v44/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v44/methods/contacts_importCard.md b/old_docs/API_docs_v44/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v44/methods/contacts_importCard.md +++ b/old_docs/API_docs_v44/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_importContacts.md b/old_docs/API_docs_v44/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v44/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v44/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v44/methods/contacts_search.md b/old_docs/API_docs_v44/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v44/methods/contacts_search.md +++ b/old_docs/API_docs_v44/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/contacts_unblock.md b/old_docs/API_docs_v44/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v44/methods/contacts_unblock.md +++ b/old_docs/API_docs_v44/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/help_getAppChangelog.md b/old_docs/API_docs_v44/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v44/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v44/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v44/methods/help_getAppUpdate.md b/old_docs/API_docs_v44/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v44/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v44/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v44/methods/help_getInviteText.md b/old_docs/API_docs_v44/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v44/methods/help_getInviteText.md +++ b/old_docs/API_docs_v44/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v44/methods/help_getTermsOfService.md b/old_docs/API_docs_v44/methods/help_getTermsOfService.md index 5b32d88f..06eda47b 100644 --- a/old_docs/API_docs_v44/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v44/methods/help_getTermsOfService.md @@ -11,9 +11,9 @@ Get terms of service ### 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: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v44/methods/help_saveAppLog.md b/old_docs/API_docs_v44/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v44/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v44/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/initConnection.md b/old_docs/API_docs_v44/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v44/methods/initConnection.md +++ b/old_docs/API_docs_v44/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v44/methods/invokeAfterMsg.md b/old_docs/API_docs_v44/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v44/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v44/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/invokeAfterMsgs.md b/old_docs/API_docs_v44/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v44/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v44/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/invokeWithLayer.md b/old_docs/API_docs_v44/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v44/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v44/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v44/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/messages_addChatUser.md b/old_docs/API_docs_v44/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v44/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v44/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v44/methods/messages_checkChatInvite.md b/old_docs/API_docs_v44/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v44/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v44/methods/messages_createChat.md b/old_docs/API_docs_v44/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v44/methods/messages_createChat.md +++ b/old_docs/API_docs_v44/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_deleteChatUser.md b/old_docs/API_docs_v44/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v44/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_deleteHistory.md b/old_docs/API_docs_v44/methods/messages_deleteHistory.md index 666b0989..4b00d3a2 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v44/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v44/methods/messages_deleteMessages.md b/old_docs/API_docs_v44/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v44/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v44/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/messages_editChatAdmin.md b/old_docs/API_docs_v44/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v44/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_editChatPhoto.md b/old_docs/API_docs_v44/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v44/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_editChatTitle.md b/old_docs/API_docs_v44/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v44/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v44/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_exportChatInvite.md b/old_docs/API_docs_v44/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v44/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v44/methods/messages_forwardMessage.md b/old_docs/API_docs_v44/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v44/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v44/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_forwardMessages.md b/old_docs/API_docs_v44/methods/messages_forwardMessages.md index a00e3df4..1bc42a02 100644 --- a/old_docs/API_docs_v44/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v44/methods/messages_forwardMessages.md @@ -11,12 +11,12 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_getAllStickers.md b/old_docs/API_docs_v44/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v44/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v44/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v44/methods/messages_getChats.md b/old_docs/API_docs_v44/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v44/methods/messages_getChats.md +++ b/old_docs/API_docs_v44/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v44/methods/messages_getDialogs.md b/old_docs/API_docs_v44/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v44/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v44/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v44/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v44/methods/messages_getHistory.md b/old_docs/API_docs_v44/methods/messages_getHistory.md index 0cbbcdc0..955f71cf 100644 --- a/old_docs/API_docs_v44/methods/messages_getHistory.md +++ b/old_docs/API_docs_v44/methods/messages_getHistory.md @@ -11,14 +11,14 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/messages_getMessages.md b/old_docs/API_docs_v44/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v44/methods/messages_getMessages.md +++ b/old_docs/API_docs_v44/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/messages_getMessagesViews.md b/old_docs/API_docs_v44/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v44/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v44/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v44/methods/messages_getStickerSet.md b/old_docs/API_docs_v44/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v44/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v44/methods/messages_getStickers.md b/old_docs/API_docs_v44/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v44/methods/messages_getStickers.md +++ b/old_docs/API_docs_v44/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v44/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v44/methods/messages_importChatInvite.md b/old_docs/API_docs_v44/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v44/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v44/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_installStickerSet.md b/old_docs/API_docs_v44/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v44/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_migrateChat.md b/old_docs/API_docs_v44/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v44/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v44/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v44/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_readHistory.md b/old_docs/API_docs_v44/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v44/methods/messages_readHistory.md +++ b/old_docs/API_docs_v44/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/messages_readMessageContents.md b/old_docs/API_docs_v44/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v44/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v44/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v44/methods/messages_receivedMessages.md b/old_docs/API_docs_v44/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v44/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v44/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md index 0b0b4e61..8fb0d3da 100644 --- a/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v44/methods/messages_reorderStickerSets.md @@ -11,9 +11,9 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_reportSpam.md b/old_docs/API_docs_v44/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v44/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v44/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_search.md b/old_docs/API_docs_v44/methods/messages_search.md index abb3c9f8..519c76f9 100644 --- a/old_docs/API_docs_v44/methods/messages_search.md +++ b/old_docs/API_docs_v44/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/messages_searchGifs.md b/old_docs/API_docs_v44/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v44/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v44/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v44/methods/messages_searchGlobal.md b/old_docs/API_docs_v44/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v44/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v44/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendBroadcast.md b/old_docs/API_docs_v44/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v44/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v44/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendEncrypted.md b/old_docs/API_docs_v44/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v44/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v44/methods/messages_sendMedia.md b/old_docs/API_docs_v44/methods/messages_sendMedia.md index dd91995c..5b315147 100644 --- a/old_docs/API_docs_v44/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v44/methods/messages_sendMedia.md @@ -11,13 +11,13 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -94,6 +94,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v44/methods/messages_sendMessage.md b/old_docs/API_docs_v44/methods/messages_sendMessage.md index fba1d624..8f8ddb48 100644 --- a/old_docs/API_docs_v44/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v44/methods/messages_sendMessage.md @@ -11,15 +11,15 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v44/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_setTyping.md b/old_docs/API_docs_v44/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v44/methods/messages_setTyping.md +++ b/old_docs/API_docs_v44/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/messages_startBot.md b/old_docs/API_docs_v44/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v44/methods/messages_startBot.md +++ b/old_docs/API_docs_v44/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v44/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v44/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v44/methods/photos_deletePhotos.md b/old_docs/API_docs_v44/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v44/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v44/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v44/methods/photos_getUserPhotos.md b/old_docs/API_docs_v44/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v44/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v44/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v44/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v44/methods/users_getUsers.md b/old_docs/API_docs_v44/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v44/methods/users_getUsers.md +++ b/old_docs/API_docs_v44/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v45/methods/account_changePhone.md b/old_docs/API_docs_v45/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v45/methods/account_changePhone.md +++ b/old_docs/API_docs_v45/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_checkUsername.md b/old_docs/API_docs_v45/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v45/methods/account_checkUsername.md +++ b/old_docs/API_docs_v45/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_deleteAccount.md b/old_docs/API_docs_v45/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v45/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v45/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_getNotifySettings.md b/old_docs/API_docs_v45/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v45/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v45/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_getPasswordSettings.md b/old_docs/API_docs_v45/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v45/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v45/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_getPrivacy.md b/old_docs/API_docs_v45/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v45/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v45/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_registerDevice.md b/old_docs/API_docs_v45/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v45/methods/account_registerDevice.md +++ b/old_docs/API_docs_v45/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/account_reportPeer.md b/old_docs/API_docs_v45/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v45/methods/account_reportPeer.md +++ b/old_docs/API_docs_v45/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_resetAuthorization.md b/old_docs/API_docs_v45/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v45/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v45/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v45/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v45/methods/account_setAccountTTL.md b/old_docs/API_docs_v45/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v45/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v45/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_setPrivacy.md b/old_docs/API_docs_v45/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v45/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v45/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_unregisterDevice.md b/old_docs/API_docs_v45/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v45/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v45/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v45/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_updateNotifySettings.md b/old_docs/API_docs_v45/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v45/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v45/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v45/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_updateProfile.md b/old_docs/API_docs_v45/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v45/methods/account_updateProfile.md +++ b/old_docs/API_docs_v45/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v45/methods/account_updateStatus.md b/old_docs/API_docs_v45/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v45/methods/account_updateStatus.md +++ b/old_docs/API_docs_v45/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/account_updateUsername.md b/old_docs/API_docs_v45/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v45/methods/account_updateUsername.md +++ b/old_docs/API_docs_v45/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/auth_checkPhone.md b/old_docs/API_docs_v45/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v45/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v45/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v45/methods/auth_recoverPassword.md b/old_docs/API_docs_v45/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v45/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v45/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/auth_sendCall.md b/old_docs/API_docs_v45/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v45/methods/auth_sendCall.md +++ b/old_docs/API_docs_v45/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/auth_sendInvites.md b/old_docs/API_docs_v45/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v45/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v45/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/auth_sendSms.md b/old_docs/API_docs_v45/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v45/methods/auth_sendSms.md +++ b/old_docs/API_docs_v45/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/channels_checkUsername.md b/old_docs/API_docs_v45/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v45/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v45/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_createChannel.md b/old_docs/API_docs_v45/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v45/methods/channels_createChannel.md +++ b/old_docs/API_docs_v45/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_deleteChannel.md b/old_docs/API_docs_v45/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v45/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_deleteMessages.md b/old_docs/API_docs_v45/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v45/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v45/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_editAbout.md b/old_docs/API_docs_v45/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v45/methods/channels_editAbout.md +++ b/old_docs/API_docs_v45/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_editAdmin.md b/old_docs/API_docs_v45/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v45/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v45/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_editPhoto.md b/old_docs/API_docs_v45/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v45/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v45/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_editTitle.md b/old_docs/API_docs_v45/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v45/methods/channels_editTitle.md +++ b/old_docs/API_docs_v45/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_exportInvite.md b/old_docs/API_docs_v45/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v45/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v45/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_getChannels.md b/old_docs/API_docs_v45/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v45/methods/channels_getChannels.md +++ b/old_docs/API_docs_v45/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_getDialogs.md b/old_docs/API_docs_v45/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v45/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v45/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v45/methods/channels_getImportantHistory.md b/old_docs/API_docs_v45/methods/channels_getImportantHistory.md index c74a35b8..e038bde8 100644 --- a/old_docs/API_docs_v45/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v45/methods/channels_getImportantHistory.md @@ -11,14 +11,14 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/channels_getMessages.md b/old_docs/API_docs_v45/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v45/methods/channels_getMessages.md +++ b/old_docs/API_docs_v45/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/channels_getParticipant.md b/old_docs/API_docs_v45/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v45/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v45/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_getParticipants.md b/old_docs/API_docs_v45/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v45/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v45/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v45/methods/channels_inviteToChannel.md b/old_docs/API_docs_v45/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v45/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v45/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_joinChannel.md b/old_docs/API_docs_v45/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v45/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v45/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_kickFromChannel.md b/old_docs/API_docs_v45/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v45/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v45/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_leaveChannel.md b/old_docs/API_docs_v45/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v45/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v45/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_readHistory.md b/old_docs/API_docs_v45/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v45/methods/channels_readHistory.md +++ b/old_docs/API_docs_v45/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_reportSpam.md b/old_docs/API_docs_v45/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v45/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v45/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/channels_toggleComments.md b/old_docs/API_docs_v45/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v45/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v45/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/channels_updateUsername.md b/old_docs/API_docs_v45/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v45/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v45/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_block.md b/old_docs/API_docs_v45/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v45/methods/contacts_block.md +++ b/old_docs/API_docs_v45/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_deleteContact.md b/old_docs/API_docs_v45/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v45/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v45/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_deleteContacts.md b/old_docs/API_docs_v45/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v45/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v45/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_getBlocked.md b/old_docs/API_docs_v45/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v45/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v45/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_getContacts.md b/old_docs/API_docs_v45/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v45/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v45/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v45/methods/contacts_getSuggested.md b/old_docs/API_docs_v45/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v45/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v45/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v45/methods/contacts_importCard.md b/old_docs/API_docs_v45/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v45/methods/contacts_importCard.md +++ b/old_docs/API_docs_v45/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_importContacts.md b/old_docs/API_docs_v45/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v45/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v45/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v45/methods/contacts_search.md b/old_docs/API_docs_v45/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v45/methods/contacts_search.md +++ b/old_docs/API_docs_v45/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/contacts_unblock.md b/old_docs/API_docs_v45/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v45/methods/contacts_unblock.md +++ b/old_docs/API_docs_v45/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/help_getAppChangelog.md b/old_docs/API_docs_v45/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v45/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v45/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v45/methods/help_getAppUpdate.md b/old_docs/API_docs_v45/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v45/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v45/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v45/methods/help_getInviteText.md b/old_docs/API_docs_v45/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v45/methods/help_getInviteText.md +++ b/old_docs/API_docs_v45/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v45/methods/help_getTermsOfService.md b/old_docs/API_docs_v45/methods/help_getTermsOfService.md index 5b32d88f..06eda47b 100644 --- a/old_docs/API_docs_v45/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v45/methods/help_getTermsOfService.md @@ -11,9 +11,9 @@ Get terms of service ### 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: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v45/methods/help_saveAppLog.md b/old_docs/API_docs_v45/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v45/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v45/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/initConnection.md b/old_docs/API_docs_v45/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v45/methods/initConnection.md +++ b/old_docs/API_docs_v45/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v45/methods/invokeAfterMsg.md b/old_docs/API_docs_v45/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v45/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v45/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/invokeAfterMsgs.md b/old_docs/API_docs_v45/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v45/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v45/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/invokeWithLayer.md b/old_docs/API_docs_v45/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v45/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v45/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v45/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/messages_addChatUser.md b/old_docs/API_docs_v45/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v45/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v45/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v45/methods/messages_checkChatInvite.md b/old_docs/API_docs_v45/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v45/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v45/methods/messages_createChat.md b/old_docs/API_docs_v45/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v45/methods/messages_createChat.md +++ b/old_docs/API_docs_v45/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_deleteChatUser.md b/old_docs/API_docs_v45/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v45/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_deleteHistory.md b/old_docs/API_docs_v45/methods/messages_deleteHistory.md index 666b0989..4b00d3a2 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v45/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v45/methods/messages_deleteMessages.md b/old_docs/API_docs_v45/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v45/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v45/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v45/methods/messages_editChatAdmin.md b/old_docs/API_docs_v45/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v45/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_editChatPhoto.md b/old_docs/API_docs_v45/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v45/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_editChatTitle.md b/old_docs/API_docs_v45/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v45/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v45/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_exportChatInvite.md b/old_docs/API_docs_v45/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v45/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v45/methods/messages_forwardMessage.md b/old_docs/API_docs_v45/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v45/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v45/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_forwardMessages.md b/old_docs/API_docs_v45/methods/messages_forwardMessages.md index a00e3df4..1bc42a02 100644 --- a/old_docs/API_docs_v45/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v45/methods/messages_forwardMessages.md @@ -11,12 +11,12 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_getAllStickers.md b/old_docs/API_docs_v45/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v45/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v45/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v45/methods/messages_getChats.md b/old_docs/API_docs_v45/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v45/methods/messages_getChats.md +++ b/old_docs/API_docs_v45/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v45/methods/messages_getDialogs.md b/old_docs/API_docs_v45/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v45/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v45/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v45/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v45/methods/messages_getHistory.md b/old_docs/API_docs_v45/methods/messages_getHistory.md index 0cbbcdc0..955f71cf 100644 --- a/old_docs/API_docs_v45/methods/messages_getHistory.md +++ b/old_docs/API_docs_v45/methods/messages_getHistory.md @@ -11,14 +11,14 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md index cd456af7..75a393ce 100644 --- a/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v45/methods/messages_getInlineBotResults.md @@ -11,11 +11,11 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v45/methods/messages_getMessages.md b/old_docs/API_docs_v45/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v45/methods/messages_getMessages.md +++ b/old_docs/API_docs_v45/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/messages_getMessagesViews.md b/old_docs/API_docs_v45/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v45/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v45/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v45/methods/messages_getSavedGifs.md b/old_docs/API_docs_v45/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v45/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v45/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v45/methods/messages_getStickerSet.md b/old_docs/API_docs_v45/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v45/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v45/methods/messages_getStickers.md b/old_docs/API_docs_v45/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v45/methods/messages_getStickers.md +++ b/old_docs/API_docs_v45/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v45/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v45/methods/messages_importChatInvite.md b/old_docs/API_docs_v45/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v45/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v45/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_installStickerSet.md b/old_docs/API_docs_v45/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v45/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_migrateChat.md b/old_docs/API_docs_v45/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v45/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v45/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v45/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_readHistory.md b/old_docs/API_docs_v45/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v45/methods/messages_readHistory.md +++ b/old_docs/API_docs_v45/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v45/methods/messages_readMessageContents.md b/old_docs/API_docs_v45/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v45/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v45/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v45/methods/messages_receivedMessages.md b/old_docs/API_docs_v45/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v45/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v45/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md index 0b0b4e61..8fb0d3da 100644 --- a/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v45/methods/messages_reorderStickerSets.md @@ -11,9 +11,9 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_reportSpam.md b/old_docs/API_docs_v45/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v45/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v45/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_saveGif.md b/old_docs/API_docs_v45/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v45/methods/messages_saveGif.md +++ b/old_docs/API_docs_v45/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_search.md b/old_docs/API_docs_v45/methods/messages_search.md index abb3c9f8..519c76f9 100644 --- a/old_docs/API_docs_v45/methods/messages_search.md +++ b/old_docs/API_docs_v45/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/messages_searchGifs.md b/old_docs/API_docs_v45/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v45/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v45/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v45/methods/messages_searchGlobal.md b/old_docs/API_docs_v45/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v45/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v45/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendBroadcast.md b/old_docs/API_docs_v45/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v45/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v45/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendEncrypted.md b/old_docs/API_docs_v45/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v45/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md index 131e072b..6be33475 100644 --- a/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v45/methods/messages_sendInlineBotResult.md @@ -11,13 +11,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_sendMedia.md b/old_docs/API_docs_v45/methods/messages_sendMedia.md index dd91995c..5b315147 100644 --- a/old_docs/API_docs_v45/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v45/methods/messages_sendMedia.md @@ -11,13 +11,13 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -94,6 +94,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v45/methods/messages_sendMessage.md b/old_docs/API_docs_v45/methods/messages_sendMessage.md index fba1d624..8f8ddb48 100644 --- a/old_docs/API_docs_v45/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v45/methods/messages_sendMessage.md @@ -11,15 +11,15 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v45/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md index e1e31f6f..62322f2b 100644 --- a/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v45/methods/messages_setInlineBotResults.md @@ -11,14 +11,14 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_setTyping.md b/old_docs/API_docs_v45/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v45/methods/messages_setTyping.md +++ b/old_docs/API_docs_v45/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/messages_startBot.md b/old_docs/API_docs_v45/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v45/methods/messages_startBot.md +++ b/old_docs/API_docs_v45/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v45/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v45/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v45/methods/photos_deletePhotos.md b/old_docs/API_docs_v45/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v45/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v45/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v45/methods/photos_getUserPhotos.md b/old_docs/API_docs_v45/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v45/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v45/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v45/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v45/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v45/methods/users_getUsers.md b/old_docs/API_docs_v45/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v45/methods/users_getUsers.md +++ b/old_docs/API_docs_v45/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v46/methods/account_changePhone.md b/old_docs/API_docs_v46/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v46/methods/account_changePhone.md +++ b/old_docs/API_docs_v46/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_checkUsername.md b/old_docs/API_docs_v46/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v46/methods/account_checkUsername.md +++ b/old_docs/API_docs_v46/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_deleteAccount.md b/old_docs/API_docs_v46/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v46/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v46/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_getNotifySettings.md b/old_docs/API_docs_v46/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v46/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v46/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_getPasswordSettings.md b/old_docs/API_docs_v46/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v46/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v46/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_getPrivacy.md b/old_docs/API_docs_v46/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v46/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v46/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_registerDevice.md b/old_docs/API_docs_v46/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v46/methods/account_registerDevice.md +++ b/old_docs/API_docs_v46/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/account_reportPeer.md b/old_docs/API_docs_v46/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v46/methods/account_reportPeer.md +++ b/old_docs/API_docs_v46/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_resetAuthorization.md b/old_docs/API_docs_v46/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v46/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v46/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md index c2d8ef15..2fcdcc4c 100644 --- a/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v46/methods/account_sendChangePhoneCode.md @@ -11,9 +11,9 @@ Change the phone number ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|New phone number| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | New phone number | Yes| ### Return type: [account\_SentChangePhoneCode](../types/account_SentChangePhoneCode.md) diff --git a/old_docs/API_docs_v46/methods/account_setAccountTTL.md b/old_docs/API_docs_v46/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v46/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v46/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_setPrivacy.md b/old_docs/API_docs_v46/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v46/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v46/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_unregisterDevice.md b/old_docs/API_docs_v46/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v46/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v46/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v46/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_updateNotifySettings.md b/old_docs/API_docs_v46/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v46/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v46/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v46/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_updateProfile.md b/old_docs/API_docs_v46/methods/account_updateProfile.md index bf9357fa..541086a6 100644 --- a/old_docs/API_docs_v46/methods/account_updateProfile.md +++ b/old_docs/API_docs_v46/methods/account_updateProfile.md @@ -11,10 +11,10 @@ Update profile info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|first\_name|[string](../types/string.md) | Yes|The first name| -|last\_name|[string](../types/string.md) | Yes|The last name| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|first\_name|[string](../types/string.md) | The first name | Yes| +|last\_name|[string](../types/string.md) | The last name | Yes| ### Return type: [User](../types/User.md) diff --git a/old_docs/API_docs_v46/methods/account_updateStatus.md b/old_docs/API_docs_v46/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v46/methods/account_updateStatus.md +++ b/old_docs/API_docs_v46/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/account_updateUsername.md b/old_docs/API_docs_v46/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v46/methods/account_updateUsername.md +++ b/old_docs/API_docs_v46/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/auth_checkPhone.md b/old_docs/API_docs_v46/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v46/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v46/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v46/methods/auth_recoverPassword.md b/old_docs/API_docs_v46/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v46/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v46/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/auth_sendCall.md b/old_docs/API_docs_v46/methods/auth_sendCall.md index 107cbc16..70a2870f 100644 --- a/old_docs/API_docs_v46/methods/auth_sendCall.md +++ b/old_docs/API_docs_v46/methods/auth_sendCall.md @@ -11,10 +11,10 @@ Send verification phone call ### 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: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/auth_sendInvites.md b/old_docs/API_docs_v46/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v46/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v46/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/auth_sendSms.md b/old_docs/API_docs_v46/methods/auth_sendSms.md index 75b9d883..6c31f570 100644 --- a/old_docs/API_docs_v46/methods/auth_sendSms.md +++ b/old_docs/API_docs_v46/methods/auth_sendSms.md @@ -11,10 +11,10 @@ Send SMS verification 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 ash| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|phone\_code\_hash|[string](../types/string.md) | Phone code ash | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/channels_checkUsername.md b/old_docs/API_docs_v46/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v46/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v46/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_createChannel.md b/old_docs/API_docs_v46/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v46/methods/channels_createChannel.md +++ b/old_docs/API_docs_v46/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_deleteChannel.md b/old_docs/API_docs_v46/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v46/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_deleteMessages.md b/old_docs/API_docs_v46/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v46/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v46/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_editAbout.md b/old_docs/API_docs_v46/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v46/methods/channels_editAbout.md +++ b/old_docs/API_docs_v46/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_editAdmin.md b/old_docs/API_docs_v46/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v46/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v46/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_editPhoto.md b/old_docs/API_docs_v46/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v46/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v46/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_editTitle.md b/old_docs/API_docs_v46/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v46/methods/channels_editTitle.md +++ b/old_docs/API_docs_v46/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_exportInvite.md b/old_docs/API_docs_v46/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v46/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v46/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_getChannels.md b/old_docs/API_docs_v46/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v46/methods/channels_getChannels.md +++ b/old_docs/API_docs_v46/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_getDialogs.md b/old_docs/API_docs_v46/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v46/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v46/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v46/methods/channels_getImportantHistory.md b/old_docs/API_docs_v46/methods/channels_getImportantHistory.md index c74a35b8..e038bde8 100644 --- a/old_docs/API_docs_v46/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v46/methods/channels_getImportantHistory.md @@ -11,14 +11,14 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/channels_getMessages.md b/old_docs/API_docs_v46/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v46/methods/channels_getMessages.md +++ b/old_docs/API_docs_v46/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/channels_getParticipant.md b/old_docs/API_docs_v46/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v46/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v46/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_getParticipants.md b/old_docs/API_docs_v46/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v46/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v46/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v46/methods/channels_inviteToChannel.md b/old_docs/API_docs_v46/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v46/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v46/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_joinChannel.md b/old_docs/API_docs_v46/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v46/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v46/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_kickFromChannel.md b/old_docs/API_docs_v46/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v46/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v46/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_leaveChannel.md b/old_docs/API_docs_v46/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v46/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v46/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_readHistory.md b/old_docs/API_docs_v46/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v46/methods/channels_readHistory.md +++ b/old_docs/API_docs_v46/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_reportSpam.md b/old_docs/API_docs_v46/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v46/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v46/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/channels_toggleComments.md b/old_docs/API_docs_v46/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v46/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v46/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/channels_updateUsername.md b/old_docs/API_docs_v46/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v46/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v46/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_block.md b/old_docs/API_docs_v46/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v46/methods/contacts_block.md +++ b/old_docs/API_docs_v46/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_deleteContact.md b/old_docs/API_docs_v46/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v46/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v46/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_deleteContacts.md b/old_docs/API_docs_v46/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v46/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v46/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_getBlocked.md b/old_docs/API_docs_v46/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v46/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v46/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_getContacts.md b/old_docs/API_docs_v46/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v46/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v46/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v46/methods/contacts_getSuggested.md b/old_docs/API_docs_v46/methods/contacts_getSuggested.md index 25109d7c..d7feb718 100644 --- a/old_docs/API_docs_v46/methods/contacts_getSuggested.md +++ b/old_docs/API_docs_v46/methods/contacts_getSuggested.md @@ -11,9 +11,9 @@ Get suggested contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [contacts\_Suggested](../types/contacts_Suggested.md) diff --git a/old_docs/API_docs_v46/methods/contacts_importCard.md b/old_docs/API_docs_v46/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v46/methods/contacts_importCard.md +++ b/old_docs/API_docs_v46/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_importContacts.md b/old_docs/API_docs_v46/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v46/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v46/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v46/methods/contacts_search.md b/old_docs/API_docs_v46/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v46/methods/contacts_search.md +++ b/old_docs/API_docs_v46/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/contacts_unblock.md b/old_docs/API_docs_v46/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v46/methods/contacts_unblock.md +++ b/old_docs/API_docs_v46/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/help_getAppChangelog.md b/old_docs/API_docs_v46/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v46/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v46/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v46/methods/help_getAppUpdate.md b/old_docs/API_docs_v46/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v46/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v46/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v46/methods/help_getInviteText.md b/old_docs/API_docs_v46/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v46/methods/help_getInviteText.md +++ b/old_docs/API_docs_v46/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v46/methods/help_getTermsOfService.md b/old_docs/API_docs_v46/methods/help_getTermsOfService.md index 5b32d88f..06eda47b 100644 --- a/old_docs/API_docs_v46/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v46/methods/help_getTermsOfService.md @@ -11,9 +11,9 @@ Get terms of service ### 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: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v46/methods/help_saveAppLog.md b/old_docs/API_docs_v46/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v46/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v46/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/initConnection.md b/old_docs/API_docs_v46/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v46/methods/initConnection.md +++ b/old_docs/API_docs_v46/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v46/methods/invokeAfterMsg.md b/old_docs/API_docs_v46/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v46/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v46/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/invokeAfterMsgs.md b/old_docs/API_docs_v46/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v46/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v46/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/invokeWithLayer.md b/old_docs/API_docs_v46/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v46/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v46/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v46/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/messages_addChatUser.md b/old_docs/API_docs_v46/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v46/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v46/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v46/methods/messages_checkChatInvite.md b/old_docs/API_docs_v46/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v46/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v46/methods/messages_createChat.md b/old_docs/API_docs_v46/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v46/methods/messages_createChat.md +++ b/old_docs/API_docs_v46/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_deleteChatUser.md b/old_docs/API_docs_v46/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v46/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_deleteHistory.md b/old_docs/API_docs_v46/methods/messages_deleteHistory.md index 666b0989..4b00d3a2 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v46/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v46/methods/messages_deleteMessages.md b/old_docs/API_docs_v46/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v46/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v46/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v46/methods/messages_editChatAdmin.md b/old_docs/API_docs_v46/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v46/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_editChatPhoto.md b/old_docs/API_docs_v46/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v46/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_editChatTitle.md b/old_docs/API_docs_v46/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v46/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v46/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_exportChatInvite.md b/old_docs/API_docs_v46/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v46/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v46/methods/messages_forwardMessage.md b/old_docs/API_docs_v46/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v46/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v46/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_forwardMessages.md b/old_docs/API_docs_v46/methods/messages_forwardMessages.md index a00e3df4..1bc42a02 100644 --- a/old_docs/API_docs_v46/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v46/methods/messages_forwardMessages.md @@ -11,12 +11,12 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_getAllStickers.md b/old_docs/API_docs_v46/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v46/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v46/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v46/methods/messages_getChats.md b/old_docs/API_docs_v46/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v46/methods/messages_getChats.md +++ b/old_docs/API_docs_v46/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v46/methods/messages_getDialogs.md b/old_docs/API_docs_v46/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v46/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v46/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v46/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v46/methods/messages_getHistory.md b/old_docs/API_docs_v46/methods/messages_getHistory.md index 0cbbcdc0..955f71cf 100644 --- a/old_docs/API_docs_v46/methods/messages_getHistory.md +++ b/old_docs/API_docs_v46/methods/messages_getHistory.md @@ -11,14 +11,14 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md index cd456af7..75a393ce 100644 --- a/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v46/methods/messages_getInlineBotResults.md @@ -11,11 +11,11 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v46/methods/messages_getMessages.md b/old_docs/API_docs_v46/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v46/methods/messages_getMessages.md +++ b/old_docs/API_docs_v46/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/messages_getMessagesViews.md b/old_docs/API_docs_v46/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v46/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v46/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v46/methods/messages_getSavedGifs.md b/old_docs/API_docs_v46/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v46/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v46/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v46/methods/messages_getStickerSet.md b/old_docs/API_docs_v46/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v46/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v46/methods/messages_getStickers.md b/old_docs/API_docs_v46/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v46/methods/messages_getStickers.md +++ b/old_docs/API_docs_v46/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v46/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v46/methods/messages_importChatInvite.md b/old_docs/API_docs_v46/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v46/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v46/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_installStickerSet.md b/old_docs/API_docs_v46/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v46/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_migrateChat.md b/old_docs/API_docs_v46/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v46/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v46/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v46/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_readHistory.md b/old_docs/API_docs_v46/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v46/methods/messages_readHistory.md +++ b/old_docs/API_docs_v46/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v46/methods/messages_readMessageContents.md b/old_docs/API_docs_v46/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v46/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v46/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v46/methods/messages_receivedMessages.md b/old_docs/API_docs_v46/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v46/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v46/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md index 0b0b4e61..8fb0d3da 100644 --- a/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v46/methods/messages_reorderStickerSets.md @@ -11,9 +11,9 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_reportSpam.md b/old_docs/API_docs_v46/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v46/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v46/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_saveGif.md b/old_docs/API_docs_v46/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v46/methods/messages_saveGif.md +++ b/old_docs/API_docs_v46/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_search.md b/old_docs/API_docs_v46/methods/messages_search.md index abb3c9f8..519c76f9 100644 --- a/old_docs/API_docs_v46/methods/messages_search.md +++ b/old_docs/API_docs_v46/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/messages_searchGifs.md b/old_docs/API_docs_v46/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v46/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v46/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v46/methods/messages_searchGlobal.md b/old_docs/API_docs_v46/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v46/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v46/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendBroadcast.md b/old_docs/API_docs_v46/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v46/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v46/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendEncrypted.md b/old_docs/API_docs_v46/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v46/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md index 131e072b..6be33475 100644 --- a/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v46/methods/messages_sendInlineBotResult.md @@ -11,13 +11,13 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_sendMedia.md b/old_docs/API_docs_v46/methods/messages_sendMedia.md index dd91995c..5b315147 100644 --- a/old_docs/API_docs_v46/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v46/methods/messages_sendMedia.md @@ -11,13 +11,13 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -94,6 +94,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v46/methods/messages_sendMessage.md b/old_docs/API_docs_v46/methods/messages_sendMessage.md index fba1d624..8f8ddb48 100644 --- a/old_docs/API_docs_v46/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v46/methods/messages_sendMessage.md @@ -11,15 +11,15 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v46/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md index e1e31f6f..62322f2b 100644 --- a/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v46/methods/messages_setInlineBotResults.md @@ -11,14 +11,14 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_setTyping.md b/old_docs/API_docs_v46/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v46/methods/messages_setTyping.md +++ b/old_docs/API_docs_v46/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/messages_startBot.md b/old_docs/API_docs_v46/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v46/methods/messages_startBot.md +++ b/old_docs/API_docs_v46/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v46/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v46/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v46/methods/photos_deletePhotos.md b/old_docs/API_docs_v46/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v46/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v46/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v46/methods/photos_getUserPhotos.md b/old_docs/API_docs_v46/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v46/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v46/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v46/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v46/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v46/methods/users_getUsers.md b/old_docs/API_docs_v46/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v46/methods/users_getUsers.md +++ b/old_docs/API_docs_v46/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v51/methods/account_changePhone.md b/old_docs/API_docs_v51/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v51/methods/account_changePhone.md +++ b/old_docs/API_docs_v51/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_checkUsername.md b/old_docs/API_docs_v51/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v51/methods/account_checkUsername.md +++ b/old_docs/API_docs_v51/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_deleteAccount.md b/old_docs/API_docs_v51/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v51/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v51/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_getNotifySettings.md b/old_docs/API_docs_v51/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v51/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v51/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_getPasswordSettings.md b/old_docs/API_docs_v51/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v51/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v51/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_getPrivacy.md b/old_docs/API_docs_v51/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v51/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v51/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_registerDevice.md b/old_docs/API_docs_v51/methods/account_registerDevice.md index 25accfae..bd2b5649 100644 --- a/old_docs/API_docs_v51/methods/account_registerDevice.md +++ b/old_docs/API_docs_v51/methods/account_registerDevice.md @@ -11,15 +11,15 @@ 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| -|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| -|app\_sandbox|[Bool](../types/Bool.md) | Yes|Should the app run in a sandbox?| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| 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| +|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| +|app\_sandbox|[Bool](../types/Bool.md) | Should the app run in a sandbox? | Yes| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/account_reportPeer.md b/old_docs/API_docs_v51/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v51/methods/account_reportPeer.md +++ b/old_docs/API_docs_v51/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_resetAuthorization.md b/old_docs/API_docs_v51/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v51/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v51/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v51/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_setAccountTTL.md b/old_docs/API_docs_v51/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v51/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v51/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_setPrivacy.md b/old_docs/API_docs_v51/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v51/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v51/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_unregisterDevice.md b/old_docs/API_docs_v51/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v51/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v51/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v51/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_updateNotifySettings.md b/old_docs/API_docs_v51/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v51/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v51/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v51/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_updateProfile.md b/old_docs/API_docs_v51/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v51/methods/account_updateProfile.md +++ b/old_docs/API_docs_v51/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_updateStatus.md b/old_docs/API_docs_v51/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v51/methods/account_updateStatus.md +++ b/old_docs/API_docs_v51/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/account_updateUsername.md b/old_docs/API_docs_v51/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v51/methods/account_updateUsername.md +++ b/old_docs/API_docs_v51/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/auth_cancelCode.md b/old_docs/API_docs_v51/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v51/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v51/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/auth_checkPhone.md b/old_docs/API_docs_v51/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v51/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v51/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v51/methods/auth_recoverPassword.md b/old_docs/API_docs_v51/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v51/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v51/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/auth_resendCode.md b/old_docs/API_docs_v51/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v51/methods/auth_resendCode.md +++ b/old_docs/API_docs_v51/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/auth_sendInvites.md b/old_docs/API_docs_v51/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v51/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v51/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/channels_checkUsername.md b/old_docs/API_docs_v51/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v51/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v51/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_createChannel.md b/old_docs/API_docs_v51/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v51/methods/channels_createChannel.md +++ b/old_docs/API_docs_v51/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_deleteChannel.md b/old_docs/API_docs_v51/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v51/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_deleteMessages.md b/old_docs/API_docs_v51/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v51/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v51/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_editAbout.md b/old_docs/API_docs_v51/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v51/methods/channels_editAbout.md +++ b/old_docs/API_docs_v51/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_editAdmin.md b/old_docs/API_docs_v51/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v51/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v51/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_editPhoto.md b/old_docs/API_docs_v51/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v51/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v51/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_editTitle.md b/old_docs/API_docs_v51/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v51/methods/channels_editTitle.md +++ b/old_docs/API_docs_v51/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_exportInvite.md b/old_docs/API_docs_v51/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v51/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v51/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_exportMessageLink.md b/old_docs/API_docs_v51/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v51/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v51/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v51/methods/channels_getChannels.md b/old_docs/API_docs_v51/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v51/methods/channels_getChannels.md +++ b/old_docs/API_docs_v51/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_getDialogs.md b/old_docs/API_docs_v51/methods/channels_getDialogs.md index ca74a033..c3acd0e6 100644 --- a/old_docs/API_docs_v51/methods/channels_getDialogs.md +++ b/old_docs/API_docs_v51/methods/channels_getDialogs.md @@ -11,10 +11,10 @@ Get channel dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset|[int](../types/int.md) | Yes|Offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset|[int](../types/int.md) | Offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v51/methods/channels_getImportantHistory.md b/old_docs/API_docs_v51/methods/channels_getImportantHistory.md index 83040d47..329b010c 100644 --- a/old_docs/API_docs_v51/methods/channels_getImportantHistory.md +++ b/old_docs/API_docs_v51/methods/channels_getImportantHistory.md @@ -11,15 +11,15 @@ Get important channel/supergroup history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The supergroup/channel| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|offset\_date|[int](../types/int.md) | Yes|Date offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The supergroup/channel | Optional| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|offset\_date|[int](../types/int.md) | Date offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/channels_getMessages.md b/old_docs/API_docs_v51/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v51/methods/channels_getMessages.md +++ b/old_docs/API_docs_v51/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/channels_getParticipant.md b/old_docs/API_docs_v51/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v51/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v51/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_getParticipants.md b/old_docs/API_docs_v51/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v51/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v51/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v51/methods/channels_inviteToChannel.md b/old_docs/API_docs_v51/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v51/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v51/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_joinChannel.md b/old_docs/API_docs_v51/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v51/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v51/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_kickFromChannel.md b/old_docs/API_docs_v51/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v51/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v51/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_leaveChannel.md b/old_docs/API_docs_v51/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v51/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v51/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_readHistory.md b/old_docs/API_docs_v51/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v51/methods/channels_readHistory.md +++ b/old_docs/API_docs_v51/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_reportSpam.md b/old_docs/API_docs_v51/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v51/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v51/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_toggleComments.md b/old_docs/API_docs_v51/methods/channels_toggleComments.md index d78127a8..52e2c7ae 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleComments.md +++ b/old_docs/API_docs_v51/methods/channels_toggleComments.md @@ -11,10 +11,10 @@ Enable channel comments ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel | -|enabled|[Bool](../types/Bool.md) | Yes|Enable or disable comments| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel | Optional| +|enabled|[Bool](../types/Bool.md) | Enable or disable comments | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/channels_toggleInvites.md b/old_docs/API_docs_v51/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v51/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_toggleSignatures.md b/old_docs/API_docs_v51/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v51/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v51/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/channels_updateUsername.md b/old_docs/API_docs_v51/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v51/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v51/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_block.md b/old_docs/API_docs_v51/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v51/methods/contacts_block.md +++ b/old_docs/API_docs_v51/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_deleteContact.md b/old_docs/API_docs_v51/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v51/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v51/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_deleteContacts.md b/old_docs/API_docs_v51/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v51/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v51/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_getBlocked.md b/old_docs/API_docs_v51/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v51/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v51/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_getContacts.md b/old_docs/API_docs_v51/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v51/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v51/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v51/methods/contacts_importCard.md b/old_docs/API_docs_v51/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v51/methods/contacts_importCard.md +++ b/old_docs/API_docs_v51/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_importContacts.md b/old_docs/API_docs_v51/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v51/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v51/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v51/methods/contacts_search.md b/old_docs/API_docs_v51/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v51/methods/contacts_search.md +++ b/old_docs/API_docs_v51/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/contacts_unblock.md b/old_docs/API_docs_v51/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v51/methods/contacts_unblock.md +++ b/old_docs/API_docs_v51/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/help_getAppChangelog.md b/old_docs/API_docs_v51/methods/help_getAppChangelog.md index e389a017..e5f9dae5 100644 --- a/old_docs/API_docs_v51/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v51/methods/help_getAppChangelog.md @@ -11,12 +11,12 @@ Get the changelog of this app ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Language code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Language code | Yes| ### Return type: [help\_AppChangelog](../types/help_AppChangelog.md) diff --git a/old_docs/API_docs_v51/methods/help_getAppUpdate.md b/old_docs/API_docs_v51/methods/help_getAppUpdate.md index 5249b87a..a501cbc5 100644 --- a/old_docs/API_docs_v51/methods/help_getAppUpdate.md +++ b/old_docs/API_docs_v51/methods/help_getAppUpdate.md @@ -11,12 +11,12 @@ Get info about app updates ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|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| -|lang\_code|[string](../types/string.md) | Yes|Langauge code| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|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| +|lang\_code|[string](../types/string.md) | Langauge code | Yes| ### Return type: [help\_AppUpdate](../types/help_AppUpdate.md) diff --git a/old_docs/API_docs_v51/methods/help_getInviteText.md b/old_docs/API_docs_v51/methods/help_getInviteText.md index 6d9e330c..1b31e572 100644 --- a/old_docs/API_docs_v51/methods/help_getInviteText.md +++ b/old_docs/API_docs_v51/methods/help_getInviteText.md @@ -11,9 +11,9 @@ Get invitation text ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|lang\_code|[string](../types/string.md) | Yes|Language| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|lang\_code|[string](../types/string.md) | Language | Yes| ### Return type: [help\_InviteText](../types/help_InviteText.md) diff --git a/old_docs/API_docs_v51/methods/help_getTermsOfService.md b/old_docs/API_docs_v51/methods/help_getTermsOfService.md index 5b32d88f..06eda47b 100644 --- a/old_docs/API_docs_v51/methods/help_getTermsOfService.md +++ b/old_docs/API_docs_v51/methods/help_getTermsOfService.md @@ -11,9 +11,9 @@ Get terms of service ### 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: [help\_TermsOfService](../types/help_TermsOfService.md) diff --git a/old_docs/API_docs_v51/methods/help_saveAppLog.md b/old_docs/API_docs_v51/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v51/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v51/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/initConnection.md b/old_docs/API_docs_v51/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v51/methods/initConnection.md +++ b/old_docs/API_docs_v51/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v51/methods/invokeAfterMsg.md b/old_docs/API_docs_v51/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v51/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v51/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/invokeAfterMsgs.md b/old_docs/API_docs_v51/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v51/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v51/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/invokeWithLayer.md b/old_docs/API_docs_v51/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v51/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v51/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v51/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/messages_addChatUser.md b/old_docs/API_docs_v51/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v51/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v51/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v51/methods/messages_checkChatInvite.md b/old_docs/API_docs_v51/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v51/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v51/methods/messages_createChat.md b/old_docs/API_docs_v51/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v51/methods/messages_createChat.md +++ b/old_docs/API_docs_v51/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_deleteChatUser.md b/old_docs/API_docs_v51/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v51/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_deleteHistory.md b/old_docs/API_docs_v51/methods/messages_deleteHistory.md index 666b0989..4b00d3a2 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v51/methods/messages_deleteHistory.md @@ -11,10 +11,10 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v51/methods/messages_deleteMessages.md b/old_docs/API_docs_v51/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v51/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v51/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v51/methods/messages_editChatAdmin.md b/old_docs/API_docs_v51/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v51/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_editChatPhoto.md b/old_docs/API_docs_v51/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v51/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_editChatTitle.md b/old_docs/API_docs_v51/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v51/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v51/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v51/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v51/methods/messages_editMessage.md b/old_docs/API_docs_v51/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v51/methods/messages_editMessage.md +++ b/old_docs/API_docs_v51/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v51/methods/messages_exportChatInvite.md b/old_docs/API_docs_v51/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v51/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v51/methods/messages_forwardMessage.md b/old_docs/API_docs_v51/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v51/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v51/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_forwardMessages.md b/old_docs/API_docs_v51/methods/messages_forwardMessages.md index e48bdcb4..18407d16 100644 --- a/old_docs/API_docs_v51/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v51/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_getAllStickers.md b/old_docs/API_docs_v51/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v51/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v51/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md index 6f26dbe6..4f9c8c05 100644 --- a/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v51/methods/messages_getBotCallbackAnswer.md @@ -11,11 +11,11 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Yes|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Yes| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v51/methods/messages_getChats.md b/old_docs/API_docs_v51/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v51/methods/messages_getChats.md +++ b/old_docs/API_docs_v51/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v51/methods/messages_getDialogs.md b/old_docs/API_docs_v51/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v51/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v51/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v51/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v51/methods/messages_getHistory.md b/old_docs/API_docs_v51/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v51/methods/messages_getHistory.md +++ b/old_docs/API_docs_v51/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v51/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v51/methods/messages_getMessageEditData.md b/old_docs/API_docs_v51/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v51/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v51/methods/messages_getMessages.md b/old_docs/API_docs_v51/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessages.md +++ b/old_docs/API_docs_v51/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/messages_getMessagesViews.md b/old_docs/API_docs_v51/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v51/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v51/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v51/methods/messages_getPeerSettings.md b/old_docs/API_docs_v51/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v51/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v51/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v51/methods/messages_getSavedGifs.md b/old_docs/API_docs_v51/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v51/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v51/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v51/methods/messages_getStickerSet.md b/old_docs/API_docs_v51/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v51/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v51/methods/messages_getStickers.md b/old_docs/API_docs_v51/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v51/methods/messages_getStickers.md +++ b/old_docs/API_docs_v51/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v51/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v51/methods/messages_hideReportSpam.md b/old_docs/API_docs_v51/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v51/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v51/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_importChatInvite.md b/old_docs/API_docs_v51/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v51/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v51/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_installStickerSet.md b/old_docs/API_docs_v51/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v51/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_migrateChat.md b/old_docs/API_docs_v51/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v51/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v51/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v51/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_readHistory.md b/old_docs/API_docs_v51/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v51/methods/messages_readHistory.md +++ b/old_docs/API_docs_v51/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v51/methods/messages_readMessageContents.md b/old_docs/API_docs_v51/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v51/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v51/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v51/methods/messages_receivedMessages.md b/old_docs/API_docs_v51/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v51/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v51/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md index 0b0b4e61..8fb0d3da 100644 --- a/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v51/methods/messages_reorderStickerSets.md @@ -11,9 +11,9 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_reportSpam.md b/old_docs/API_docs_v51/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v51/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v51/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_saveGif.md b/old_docs/API_docs_v51/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v51/methods/messages_saveGif.md +++ b/old_docs/API_docs_v51/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_search.md b/old_docs/API_docs_v51/methods/messages_search.md index abb3c9f8..519c76f9 100644 --- a/old_docs/API_docs_v51/methods/messages_search.md +++ b/old_docs/API_docs_v51/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|important\_only|[Bool](../types/Bool.md) | Show only important messages | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/messages_searchGifs.md b/old_docs/API_docs_v51/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v51/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v51/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v51/methods/messages_searchGlobal.md b/old_docs/API_docs_v51/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v51/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v51/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendBroadcast.md b/old_docs/API_docs_v51/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v51/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v51/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendEncrypted.md b/old_docs/API_docs_v51/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v51/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md index 13ebae6e..90befdec 100644 --- a/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v51/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_sendMedia.md b/old_docs/API_docs_v51/methods/messages_sendMedia.md index 449b8936..e9f3c1a0 100644 --- a/old_docs/API_docs_v51/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v51/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v51/methods/messages_sendMessage.md b/old_docs/API_docs_v51/methods/messages_sendMessage.md index ef5a29f1..e6b5ae1f 100644 --- a/old_docs/API_docs_v51/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v51/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|broadcast|[Bool](../types/Bool.md) | Optional|Broadcast this message| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|broadcast|[Bool](../types/Bool.md) | Broadcast this message | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md index 6b0ff6ff..39b03385 100644 --- a/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v51/methods/messages_setBotCallbackAnswer.md @@ -11,11 +11,11 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v51/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v51/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_setTyping.md b/old_docs/API_docs_v51/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v51/methods/messages_setTyping.md +++ b/old_docs/API_docs_v51/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/messages_startBot.md b/old_docs/API_docs_v51/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v51/methods/messages_startBot.md +++ b/old_docs/API_docs_v51/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v51/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v51/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v51/methods/photos_deletePhotos.md b/old_docs/API_docs_v51/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v51/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v51/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v51/methods/photos_getUserPhotos.md b/old_docs/API_docs_v51/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v51/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v51/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v51/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v51/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v51/methods/users_getUsers.md b/old_docs/API_docs_v51/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v51/methods/users_getUsers.md +++ b/old_docs/API_docs_v51/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v53/methods/account_changePhone.md b/old_docs/API_docs_v53/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v53/methods/account_changePhone.md +++ b/old_docs/API_docs_v53/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_checkUsername.md b/old_docs/API_docs_v53/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v53/methods/account_checkUsername.md +++ b/old_docs/API_docs_v53/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_deleteAccount.md b/old_docs/API_docs_v53/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v53/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v53/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_getNotifySettings.md b/old_docs/API_docs_v53/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v53/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v53/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_getPasswordSettings.md b/old_docs/API_docs_v53/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v53/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v53/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_getPrivacy.md b/old_docs/API_docs_v53/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v53/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v53/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_registerDevice.md b/old_docs/API_docs_v53/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v53/methods/account_registerDevice.md +++ b/old_docs/API_docs_v53/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/account_reportPeer.md b/old_docs/API_docs_v53/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v53/methods/account_reportPeer.md +++ b/old_docs/API_docs_v53/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_resetAuthorization.md b/old_docs/API_docs_v53/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v53/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v53/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v53/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_setAccountTTL.md b/old_docs/API_docs_v53/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v53/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v53/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_setPrivacy.md b/old_docs/API_docs_v53/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v53/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v53/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_unregisterDevice.md b/old_docs/API_docs_v53/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v53/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v53/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v53/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_updateNotifySettings.md b/old_docs/API_docs_v53/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v53/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v53/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v53/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_updateProfile.md b/old_docs/API_docs_v53/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v53/methods/account_updateProfile.md +++ b/old_docs/API_docs_v53/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_updateStatus.md b/old_docs/API_docs_v53/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v53/methods/account_updateStatus.md +++ b/old_docs/API_docs_v53/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/account_updateUsername.md b/old_docs/API_docs_v53/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v53/methods/account_updateUsername.md +++ b/old_docs/API_docs_v53/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/auth_cancelCode.md b/old_docs/API_docs_v53/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v53/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v53/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/auth_checkPhone.md b/old_docs/API_docs_v53/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v53/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v53/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v53/methods/auth_recoverPassword.md b/old_docs/API_docs_v53/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v53/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v53/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/auth_resendCode.md b/old_docs/API_docs_v53/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v53/methods/auth_resendCode.md +++ b/old_docs/API_docs_v53/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/auth_sendInvites.md b/old_docs/API_docs_v53/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v53/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v53/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/channels_checkUsername.md b/old_docs/API_docs_v53/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v53/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v53/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_createChannel.md b/old_docs/API_docs_v53/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v53/methods/channels_createChannel.md +++ b/old_docs/API_docs_v53/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_deleteChannel.md b/old_docs/API_docs_v53/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v53/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_deleteMessages.md b/old_docs/API_docs_v53/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v53/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v53/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_editAbout.md b/old_docs/API_docs_v53/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v53/methods/channels_editAbout.md +++ b/old_docs/API_docs_v53/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_editAdmin.md b/old_docs/API_docs_v53/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v53/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v53/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_editPhoto.md b/old_docs/API_docs_v53/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v53/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v53/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_editTitle.md b/old_docs/API_docs_v53/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v53/methods/channels_editTitle.md +++ b/old_docs/API_docs_v53/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_exportInvite.md b/old_docs/API_docs_v53/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v53/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v53/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_exportMessageLink.md b/old_docs/API_docs_v53/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v53/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v53/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v53/methods/channels_getChannels.md b/old_docs/API_docs_v53/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v53/methods/channels_getChannels.md +++ b/old_docs/API_docs_v53/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_getMessages.md b/old_docs/API_docs_v53/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v53/methods/channels_getMessages.md +++ b/old_docs/API_docs_v53/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/channels_getParticipant.md b/old_docs/API_docs_v53/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v53/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v53/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_getParticipants.md b/old_docs/API_docs_v53/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v53/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v53/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v53/methods/channels_inviteToChannel.md b/old_docs/API_docs_v53/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v53/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v53/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_joinChannel.md b/old_docs/API_docs_v53/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v53/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v53/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_kickFromChannel.md b/old_docs/API_docs_v53/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v53/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v53/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/channels_leaveChannel.md b/old_docs/API_docs_v53/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v53/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v53/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_readHistory.md b/old_docs/API_docs_v53/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v53/methods/channels_readHistory.md +++ b/old_docs/API_docs_v53/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_reportSpam.md b/old_docs/API_docs_v53/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v53/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v53/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_toggleInvites.md b/old_docs/API_docs_v53/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v53/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v53/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_toggleSignatures.md b/old_docs/API_docs_v53/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v53/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v53/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v53/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/channels_updateUsername.md b/old_docs/API_docs_v53/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v53/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v53/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_block.md b/old_docs/API_docs_v53/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v53/methods/contacts_block.md +++ b/old_docs/API_docs_v53/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_deleteContact.md b/old_docs/API_docs_v53/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v53/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v53/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_deleteContacts.md b/old_docs/API_docs_v53/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v53/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v53/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_getBlocked.md b/old_docs/API_docs_v53/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v53/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v53/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_getContacts.md b/old_docs/API_docs_v53/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v53/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v53/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v53/methods/contacts_getTopPeers.md b/old_docs/API_docs_v53/methods/contacts_getTopPeers.md index 29dbb3ba..d81bb6ef 100644 --- a/old_docs/API_docs_v53/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v53/methods/contacts_getTopPeers.md @@ -11,16 +11,16 @@ 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?| -|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| +|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) diff --git a/old_docs/API_docs_v53/methods/contacts_importCard.md b/old_docs/API_docs_v53/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v53/methods/contacts_importCard.md +++ b/old_docs/API_docs_v53/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_importContacts.md b/old_docs/API_docs_v53/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v53/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v53/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v53/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_search.md b/old_docs/API_docs_v53/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v53/methods/contacts_search.md +++ b/old_docs/API_docs_v53/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/contacts_unblock.md b/old_docs/API_docs_v53/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v53/methods/contacts_unblock.md +++ b/old_docs/API_docs_v53/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/help_saveAppLog.md b/old_docs/API_docs_v53/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v53/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v53/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/initConnection.md b/old_docs/API_docs_v53/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v53/methods/initConnection.md +++ b/old_docs/API_docs_v53/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v53/methods/invokeAfterMsg.md b/old_docs/API_docs_v53/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v53/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v53/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/invokeAfterMsgs.md b/old_docs/API_docs_v53/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v53/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v53/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/invokeWithLayer.md b/old_docs/API_docs_v53/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v53/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v53/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v53/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/messages_addChatUser.md b/old_docs/API_docs_v53/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v53/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v53/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v53/methods/messages_checkChatInvite.md b/old_docs/API_docs_v53/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v53/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v53/methods/messages_createChat.md b/old_docs/API_docs_v53/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v53/methods/messages_createChat.md +++ b/old_docs/API_docs_v53/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_deleteChatUser.md b/old_docs/API_docs_v53/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v53/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_deleteHistory.md b/old_docs/API_docs_v53/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v53/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v53/methods/messages_deleteMessages.md b/old_docs/API_docs_v53/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v53/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v53/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v53/methods/messages_editChatAdmin.md b/old_docs/API_docs_v53/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v53/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_editChatPhoto.md b/old_docs/API_docs_v53/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v53/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_editChatTitle.md b/old_docs/API_docs_v53/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v53/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v53/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v53/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_editMessage.md b/old_docs/API_docs_v53/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v53/methods/messages_editMessage.md +++ b/old_docs/API_docs_v53/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_exportChatInvite.md b/old_docs/API_docs_v53/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v53/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v53/methods/messages_forwardMessage.md b/old_docs/API_docs_v53/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v53/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v53/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_forwardMessages.md b/old_docs/API_docs_v53/methods/messages_forwardMessages.md index 499f15ee..e2487c6c 100644 --- a/old_docs/API_docs_v53/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v53/methods/messages_forwardMessages.md @@ -11,13 +11,13 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_getAllStickers.md b/old_docs/API_docs_v53/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v53/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v53/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md index 6f26dbe6..4f9c8c05 100644 --- a/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v53/methods/messages_getBotCallbackAnswer.md @@ -11,11 +11,11 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Yes|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Yes| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v53/methods/messages_getChats.md b/old_docs/API_docs_v53/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v53/methods/messages_getChats.md +++ b/old_docs/API_docs_v53/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v53/methods/messages_getDialogs.md b/old_docs/API_docs_v53/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v53/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v53/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v53/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v53/methods/messages_getHistory.md b/old_docs/API_docs_v53/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v53/methods/messages_getHistory.md +++ b/old_docs/API_docs_v53/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v53/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v53/methods/messages_getMessageEditData.md b/old_docs/API_docs_v53/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v53/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v53/methods/messages_getMessages.md b/old_docs/API_docs_v53/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessages.md +++ b/old_docs/API_docs_v53/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/messages_getMessagesViews.md b/old_docs/API_docs_v53/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v53/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v53/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v53/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v53/methods/messages_getPeerSettings.md b/old_docs/API_docs_v53/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v53/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v53/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v53/methods/messages_getSavedGifs.md b/old_docs/API_docs_v53/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v53/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v53/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v53/methods/messages_getStickerSet.md b/old_docs/API_docs_v53/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v53/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v53/methods/messages_getStickers.md b/old_docs/API_docs_v53/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v53/methods/messages_getStickers.md +++ b/old_docs/API_docs_v53/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v53/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v53/methods/messages_hideReportSpam.md b/old_docs/API_docs_v53/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v53/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v53/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_importChatInvite.md b/old_docs/API_docs_v53/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v53/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v53/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_installStickerSet.md b/old_docs/API_docs_v53/methods/messages_installStickerSet.md index 0fdb700b..1cd832e5 100644 --- a/old_docs/API_docs_v53/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|disabled|[Bool](../types/Bool.md) | Yes|Disable stickerset?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|disabled|[Bool](../types/Bool.md) | Disable stickerset? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_migrateChat.md b/old_docs/API_docs_v53/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v53/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v53/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v53/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_readHistory.md b/old_docs/API_docs_v53/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v53/methods/messages_readHistory.md +++ b/old_docs/API_docs_v53/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v53/methods/messages_readMessageContents.md b/old_docs/API_docs_v53/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v53/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v53/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v53/methods/messages_receivedMessages.md b/old_docs/API_docs_v53/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v53/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v53/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md index 0b0b4e61..8fb0d3da 100644 --- a/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v53/methods/messages_reorderStickerSets.md @@ -11,9 +11,9 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_reportSpam.md b/old_docs/API_docs_v53/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v53/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v53/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_saveDraft.md b/old_docs/API_docs_v53/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v53/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v53/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_saveGif.md b/old_docs/API_docs_v53/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v53/methods/messages_saveGif.md +++ b/old_docs/API_docs_v53/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_search.md b/old_docs/API_docs_v53/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v53/methods/messages_search.md +++ b/old_docs/API_docs_v53/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/messages_searchGifs.md b/old_docs/API_docs_v53/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v53/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v53/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v53/methods/messages_searchGlobal.md b/old_docs/API_docs_v53/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v53/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v53/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendBroadcast.md b/old_docs/API_docs_v53/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v53/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v53/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendEncrypted.md b/old_docs/API_docs_v53/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v53/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v53/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_sendMedia.md b/old_docs/API_docs_v53/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v53/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v53/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v53/methods/messages_sendMessage.md b/old_docs/API_docs_v53/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v53/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v53/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md index 6b0ff6ff..39b03385 100644 --- a/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v53/methods/messages_setBotCallbackAnswer.md @@ -11,11 +11,11 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v53/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v53/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_setTyping.md b/old_docs/API_docs_v53/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v53/methods/messages_setTyping.md +++ b/old_docs/API_docs_v53/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/messages_startBot.md b/old_docs/API_docs_v53/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v53/methods/messages_startBot.md +++ b/old_docs/API_docs_v53/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v53/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v53/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v53/methods/photos_deletePhotos.md b/old_docs/API_docs_v53/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v53/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v53/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v53/methods/photos_getUserPhotos.md b/old_docs/API_docs_v53/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v53/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v53/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v53/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v53/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v53/methods/users_getUsers.md b/old_docs/API_docs_v53/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v53/methods/users_getUsers.md +++ b/old_docs/API_docs_v53/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v55/methods/account_changePhone.md b/old_docs/API_docs_v55/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v55/methods/account_changePhone.md +++ b/old_docs/API_docs_v55/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_checkUsername.md b/old_docs/API_docs_v55/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v55/methods/account_checkUsername.md +++ b/old_docs/API_docs_v55/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_confirmPhone.md b/old_docs/API_docs_v55/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v55/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v55/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_deleteAccount.md b/old_docs/API_docs_v55/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v55/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v55/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_getNotifySettings.md b/old_docs/API_docs_v55/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v55/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v55/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_getPasswordSettings.md b/old_docs/API_docs_v55/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v55/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v55/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_getPrivacy.md b/old_docs/API_docs_v55/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v55/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v55/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_registerDevice.md b/old_docs/API_docs_v55/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v55/methods/account_registerDevice.md +++ b/old_docs/API_docs_v55/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/account_reportPeer.md b/old_docs/API_docs_v55/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v55/methods/account_reportPeer.md +++ b/old_docs/API_docs_v55/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_resetAuthorization.md b/old_docs/API_docs_v55/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v55/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v55/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v55/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v55/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_setAccountTTL.md b/old_docs/API_docs_v55/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v55/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v55/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_setPrivacy.md b/old_docs/API_docs_v55/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v55/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v55/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_unregisterDevice.md b/old_docs/API_docs_v55/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v55/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v55/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v55/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_updateNotifySettings.md b/old_docs/API_docs_v55/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v55/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v55/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v55/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_updateProfile.md b/old_docs/API_docs_v55/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v55/methods/account_updateProfile.md +++ b/old_docs/API_docs_v55/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_updateStatus.md b/old_docs/API_docs_v55/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v55/methods/account_updateStatus.md +++ b/old_docs/API_docs_v55/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/account_updateUsername.md b/old_docs/API_docs_v55/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v55/methods/account_updateUsername.md +++ b/old_docs/API_docs_v55/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/auth_cancelCode.md b/old_docs/API_docs_v55/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v55/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v55/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/auth_checkPhone.md b/old_docs/API_docs_v55/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v55/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v55/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v55/methods/auth_recoverPassword.md b/old_docs/API_docs_v55/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v55/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v55/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/auth_resendCode.md b/old_docs/API_docs_v55/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v55/methods/auth_resendCode.md +++ b/old_docs/API_docs_v55/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/auth_sendInvites.md b/old_docs/API_docs_v55/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v55/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v55/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/channels_checkUsername.md b/old_docs/API_docs_v55/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v55/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v55/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_createChannel.md b/old_docs/API_docs_v55/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v55/methods/channels_createChannel.md +++ b/old_docs/API_docs_v55/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_deleteChannel.md b/old_docs/API_docs_v55/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v55/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_deleteMessages.md b/old_docs/API_docs_v55/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v55/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v55/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_editAbout.md b/old_docs/API_docs_v55/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v55/methods/channels_editAbout.md +++ b/old_docs/API_docs_v55/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_editAdmin.md b/old_docs/API_docs_v55/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v55/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v55/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_editPhoto.md b/old_docs/API_docs_v55/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v55/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v55/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_editTitle.md b/old_docs/API_docs_v55/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v55/methods/channels_editTitle.md +++ b/old_docs/API_docs_v55/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_exportInvite.md b/old_docs/API_docs_v55/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v55/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v55/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_exportMessageLink.md b/old_docs/API_docs_v55/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v55/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v55/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v55/methods/channels_getChannels.md b/old_docs/API_docs_v55/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v55/methods/channels_getChannels.md +++ b/old_docs/API_docs_v55/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_getMessages.md b/old_docs/API_docs_v55/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v55/methods/channels_getMessages.md +++ b/old_docs/API_docs_v55/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/channels_getParticipant.md b/old_docs/API_docs_v55/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v55/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v55/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_getParticipants.md b/old_docs/API_docs_v55/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v55/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v55/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v55/methods/channels_inviteToChannel.md b/old_docs/API_docs_v55/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v55/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v55/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_joinChannel.md b/old_docs/API_docs_v55/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v55/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v55/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_kickFromChannel.md b/old_docs/API_docs_v55/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v55/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v55/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/channels_leaveChannel.md b/old_docs/API_docs_v55/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v55/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v55/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_readHistory.md b/old_docs/API_docs_v55/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v55/methods/channels_readHistory.md +++ b/old_docs/API_docs_v55/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_reportSpam.md b/old_docs/API_docs_v55/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v55/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v55/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_toggleInvites.md b/old_docs/API_docs_v55/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v55/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v55/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_toggleSignatures.md b/old_docs/API_docs_v55/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v55/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v55/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v55/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/channels_updateUsername.md b/old_docs/API_docs_v55/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v55/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v55/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_block.md b/old_docs/API_docs_v55/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v55/methods/contacts_block.md +++ b/old_docs/API_docs_v55/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_deleteContact.md b/old_docs/API_docs_v55/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v55/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v55/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_deleteContacts.md b/old_docs/API_docs_v55/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v55/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v55/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_getBlocked.md b/old_docs/API_docs_v55/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v55/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v55/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_getContacts.md b/old_docs/API_docs_v55/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v55/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v55/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v55/methods/contacts_getTopPeers.md b/old_docs/API_docs_v55/methods/contacts_getTopPeers.md index 29dbb3ba..d81bb6ef 100644 --- a/old_docs/API_docs_v55/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v55/methods/contacts_getTopPeers.md @@ -11,16 +11,16 @@ 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?| -|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| +|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) diff --git a/old_docs/API_docs_v55/methods/contacts_importCard.md b/old_docs/API_docs_v55/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v55/methods/contacts_importCard.md +++ b/old_docs/API_docs_v55/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_importContacts.md b/old_docs/API_docs_v55/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v55/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v55/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v55/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_search.md b/old_docs/API_docs_v55/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v55/methods/contacts_search.md +++ b/old_docs/API_docs_v55/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/contacts_unblock.md b/old_docs/API_docs_v55/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v55/methods/contacts_unblock.md +++ b/old_docs/API_docs_v55/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/help_saveAppLog.md b/old_docs/API_docs_v55/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v55/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v55/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/initConnection.md b/old_docs/API_docs_v55/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v55/methods/initConnection.md +++ b/old_docs/API_docs_v55/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v55/methods/invokeAfterMsg.md b/old_docs/API_docs_v55/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v55/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v55/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/invokeAfterMsgs.md b/old_docs/API_docs_v55/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v55/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v55/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/invokeWithLayer.md b/old_docs/API_docs_v55/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v55/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v55/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v55/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/messages_addChatUser.md b/old_docs/API_docs_v55/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v55/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v55/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v55/methods/messages_checkChatInvite.md b/old_docs/API_docs_v55/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v55/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v55/methods/messages_createChat.md b/old_docs/API_docs_v55/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v55/methods/messages_createChat.md +++ b/old_docs/API_docs_v55/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_deleteChatUser.md b/old_docs/API_docs_v55/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v55/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_deleteHistory.md b/old_docs/API_docs_v55/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v55/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v55/methods/messages_deleteMessages.md b/old_docs/API_docs_v55/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v55/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v55/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v55/methods/messages_editChatAdmin.md b/old_docs/API_docs_v55/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v55/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_editChatPhoto.md b/old_docs/API_docs_v55/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v55/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_editChatTitle.md b/old_docs/API_docs_v55/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v55/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v55/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v55/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_editMessage.md b/old_docs/API_docs_v55/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v55/methods/messages_editMessage.md +++ b/old_docs/API_docs_v55/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_exportChatInvite.md b/old_docs/API_docs_v55/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v55/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v55/methods/messages_forwardMessage.md b/old_docs/API_docs_v55/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v55/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v55/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_forwardMessages.md b/old_docs/API_docs_v55/methods/messages_forwardMessages.md index 499f15ee..e2487c6c 100644 --- a/old_docs/API_docs_v55/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v55/methods/messages_forwardMessages.md @@ -11,13 +11,13 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_getAllStickers.md b/old_docs/API_docs_v55/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v55/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md index 52fe657f..f602ec0f 100644 --- a/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getArchivedStickers.md @@ -11,10 +11,10 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md index 6f26dbe6..4f9c8c05 100644 --- a/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v55/methods/messages_getBotCallbackAnswer.md @@ -11,11 +11,11 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Yes|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Yes| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v55/methods/messages_getChats.md b/old_docs/API_docs_v55/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v55/methods/messages_getChats.md +++ b/old_docs/API_docs_v55/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v55/methods/messages_getDialogs.md b/old_docs/API_docs_v55/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v55/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v55/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v55/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getHistory.md b/old_docs/API_docs_v55/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v55/methods/messages_getHistory.md +++ b/old_docs/API_docs_v55/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v55/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v55/methods/messages_getMessageEditData.md b/old_docs/API_docs_v55/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v55/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v55/methods/messages_getMessages.md b/old_docs/API_docs_v55/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessages.md +++ b/old_docs/API_docs_v55/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/messages_getMessagesViews.md b/old_docs/API_docs_v55/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v55/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v55/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v55/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v55/methods/messages_getPeerSettings.md b/old_docs/API_docs_v55/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v55/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v55/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v55/methods/messages_getRecentStickers.md b/old_docs/API_docs_v55/methods/messages_getRecentStickers.md index d02d08a1..fa0287d7 100644 --- a/old_docs/API_docs_v55/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getRecentStickers.md @@ -11,9 +11,9 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getSavedGifs.md b/old_docs/API_docs_v55/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v55/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v55/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v55/methods/messages_getStickerSet.md b/old_docs/API_docs_v55/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v55/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v55/methods/messages_getStickers.md b/old_docs/API_docs_v55/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v55/methods/messages_getStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md b/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md index 3193b812..19b28b88 100644 --- a/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md +++ b/old_docs/API_docs_v55/methods/messages_getUnusedStickers.md @@ -11,9 +11,9 @@ Get unused stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v55/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v55/methods/messages_hideReportSpam.md b/old_docs/API_docs_v55/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v55/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v55/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_importChatInvite.md b/old_docs/API_docs_v55/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v55/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v55/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_installStickerSet.md b/old_docs/API_docs_v55/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v55/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v55/methods/messages_migrateChat.md b/old_docs/API_docs_v55/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v55/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v55/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v55/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_readHistory.md b/old_docs/API_docs_v55/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v55/methods/messages_readHistory.md +++ b/old_docs/API_docs_v55/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v55/methods/messages_readMessageContents.md b/old_docs/API_docs_v55/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v55/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v55/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v55/methods/messages_receivedMessages.md b/old_docs/API_docs_v55/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v55/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v55/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md index 0b0b4e61..8fb0d3da 100644 --- a/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v55/methods/messages_reorderStickerSets.md @@ -11,9 +11,9 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_reportSpam.md b/old_docs/API_docs_v55/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v55/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v55/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_saveDraft.md b/old_docs/API_docs_v55/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v55/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v55/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_saveGif.md b/old_docs/API_docs_v55/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v55/methods/messages_saveGif.md +++ b/old_docs/API_docs_v55/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md index 5ab9d9c8..a071571e 100644 --- a/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v55/methods/messages_saveRecentSticker.md @@ -11,10 +11,10 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_search.md b/old_docs/API_docs_v55/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v55/methods/messages_search.md +++ b/old_docs/API_docs_v55/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/messages_searchGifs.md b/old_docs/API_docs_v55/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v55/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v55/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v55/methods/messages_searchGlobal.md b/old_docs/API_docs_v55/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v55/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v55/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendBroadcast.md b/old_docs/API_docs_v55/methods/messages_sendBroadcast.md index bebf422a..11f43d4c 100644 --- a/old_docs/API_docs_v55/methods/messages_sendBroadcast.md +++ b/old_docs/API_docs_v55/methods/messages_sendBroadcast.md @@ -11,11 +11,11 @@ Send a message to all users in the chat list ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message| -|message|[string](../types/string.md) | Yes|The message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes| +|message|[string](../types/string.md) | The message | Yes| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendEncrypted.md b/old_docs/API_docs_v55/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v55/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v55/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_sendMedia.md b/old_docs/API_docs_v55/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v55/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v55/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v55/methods/messages_sendMessage.md b/old_docs/API_docs_v55/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v55/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v55/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md index 41d9fa9e..e75a6d4c 100644 --- a/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v55/methods/messages_setBotCallbackAnswer.md @@ -11,12 +11,12 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v55/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v55/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_setTyping.md b/old_docs/API_docs_v55/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v55/methods/messages_setTyping.md +++ b/old_docs/API_docs_v55/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/messages_startBot.md b/old_docs/API_docs_v55/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v55/methods/messages_startBot.md +++ b/old_docs/API_docs_v55/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v55/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v55/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v55/methods/photos_deletePhotos.md b/old_docs/API_docs_v55/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v55/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v55/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v55/methods/photos_getUserPhotos.md b/old_docs/API_docs_v55/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v55/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v55/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md index 0c9dfa01..706f0a01 100644 --- a/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v55/methods/photos_updateProfilePhoto.md @@ -11,10 +11,10 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md index 45f8ac5e..99064210 100644 --- a/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v55/methods/photos_uploadProfilePhoto.md @@ -11,12 +11,12 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| -|caption|[string](../types/string.md) | Yes|Caption type| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|Location| -|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Yes|Cropping info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| +|caption|[string](../types/string.md) | Caption type | Yes| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Location | Optional| +|crop|[InputPhotoCrop](../types/InputPhotoCrop.md) | Cropping info | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v55/methods/users_getUsers.md b/old_docs/API_docs_v55/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v55/methods/users_getUsers.md +++ b/old_docs/API_docs_v55/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v57/methods/account_changePhone.md b/old_docs/API_docs_v57/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v57/methods/account_changePhone.md +++ b/old_docs/API_docs_v57/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_checkUsername.md b/old_docs/API_docs_v57/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v57/methods/account_checkUsername.md +++ b/old_docs/API_docs_v57/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_confirmPhone.md b/old_docs/API_docs_v57/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v57/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v57/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_deleteAccount.md b/old_docs/API_docs_v57/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v57/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v57/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_getNotifySettings.md b/old_docs/API_docs_v57/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v57/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v57/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_getPasswordSettings.md b/old_docs/API_docs_v57/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v57/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v57/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_getPrivacy.md b/old_docs/API_docs_v57/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v57/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v57/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_registerDevice.md b/old_docs/API_docs_v57/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v57/methods/account_registerDevice.md +++ b/old_docs/API_docs_v57/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/account_reportPeer.md b/old_docs/API_docs_v57/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v57/methods/account_reportPeer.md +++ b/old_docs/API_docs_v57/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_resetAuthorization.md b/old_docs/API_docs_v57/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v57/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v57/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v57/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v57/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_setAccountTTL.md b/old_docs/API_docs_v57/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v57/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v57/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_setPrivacy.md b/old_docs/API_docs_v57/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v57/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v57/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_unregisterDevice.md b/old_docs/API_docs_v57/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v57/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v57/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v57/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_updateNotifySettings.md b/old_docs/API_docs_v57/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v57/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v57/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v57/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_updateProfile.md b/old_docs/API_docs_v57/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v57/methods/account_updateProfile.md +++ b/old_docs/API_docs_v57/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_updateStatus.md b/old_docs/API_docs_v57/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v57/methods/account_updateStatus.md +++ b/old_docs/API_docs_v57/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/account_updateUsername.md b/old_docs/API_docs_v57/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v57/methods/account_updateUsername.md +++ b/old_docs/API_docs_v57/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/auth_cancelCode.md b/old_docs/API_docs_v57/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v57/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v57/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/auth_checkPhone.md b/old_docs/API_docs_v57/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v57/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v57/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v57/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/auth_recoverPassword.md b/old_docs/API_docs_v57/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v57/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v57/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/auth_resendCode.md b/old_docs/API_docs_v57/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v57/methods/auth_resendCode.md +++ b/old_docs/API_docs_v57/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/auth_sendInvites.md b/old_docs/API_docs_v57/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v57/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v57/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/channels_checkUsername.md b/old_docs/API_docs_v57/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v57/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v57/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_createChannel.md b/old_docs/API_docs_v57/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v57/methods/channels_createChannel.md +++ b/old_docs/API_docs_v57/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_deleteChannel.md b/old_docs/API_docs_v57/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v57/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_deleteMessages.md b/old_docs/API_docs_v57/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v57/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v57/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_editAbout.md b/old_docs/API_docs_v57/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v57/methods/channels_editAbout.md +++ b/old_docs/API_docs_v57/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_editAdmin.md b/old_docs/API_docs_v57/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v57/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v57/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_editPhoto.md b/old_docs/API_docs_v57/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v57/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v57/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_editTitle.md b/old_docs/API_docs_v57/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v57/methods/channels_editTitle.md +++ b/old_docs/API_docs_v57/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_exportInvite.md b/old_docs/API_docs_v57/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v57/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v57/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_exportMessageLink.md b/old_docs/API_docs_v57/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v57/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v57/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v57/methods/channels_getChannels.md b/old_docs/API_docs_v57/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v57/methods/channels_getChannels.md +++ b/old_docs/API_docs_v57/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_getMessages.md b/old_docs/API_docs_v57/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v57/methods/channels_getMessages.md +++ b/old_docs/API_docs_v57/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/channels_getParticipant.md b/old_docs/API_docs_v57/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v57/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v57/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_getParticipants.md b/old_docs/API_docs_v57/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v57/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v57/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v57/methods/channels_inviteToChannel.md b/old_docs/API_docs_v57/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v57/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v57/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_joinChannel.md b/old_docs/API_docs_v57/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v57/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v57/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_kickFromChannel.md b/old_docs/API_docs_v57/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v57/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v57/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/channels_leaveChannel.md b/old_docs/API_docs_v57/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v57/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v57/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_readHistory.md b/old_docs/API_docs_v57/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v57/methods/channels_readHistory.md +++ b/old_docs/API_docs_v57/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_reportSpam.md b/old_docs/API_docs_v57/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v57/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v57/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_toggleInvites.md b/old_docs/API_docs_v57/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v57/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v57/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_toggleSignatures.md b/old_docs/API_docs_v57/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v57/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v57/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v57/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/channels_updateUsername.md b/old_docs/API_docs_v57/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v57/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v57/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_block.md b/old_docs/API_docs_v57/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v57/methods/contacts_block.md +++ b/old_docs/API_docs_v57/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_deleteContact.md b/old_docs/API_docs_v57/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v57/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v57/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_deleteContacts.md b/old_docs/API_docs_v57/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v57/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v57/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_getBlocked.md b/old_docs/API_docs_v57/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v57/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v57/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_getContacts.md b/old_docs/API_docs_v57/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v57/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v57/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v57/methods/contacts_getTopPeers.md b/old_docs/API_docs_v57/methods/contacts_getTopPeers.md index 29dbb3ba..d81bb6ef 100644 --- a/old_docs/API_docs_v57/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v57/methods/contacts_getTopPeers.md @@ -11,16 +11,16 @@ 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?| -|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| +|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) diff --git a/old_docs/API_docs_v57/methods/contacts_importCard.md b/old_docs/API_docs_v57/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v57/methods/contacts_importCard.md +++ b/old_docs/API_docs_v57/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_importContacts.md b/old_docs/API_docs_v57/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v57/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v57/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v57/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_search.md b/old_docs/API_docs_v57/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v57/methods/contacts_search.md +++ b/old_docs/API_docs_v57/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/contacts_unblock.md b/old_docs/API_docs_v57/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v57/methods/contacts_unblock.md +++ b/old_docs/API_docs_v57/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/help_saveAppLog.md b/old_docs/API_docs_v57/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v57/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v57/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/initConnection.md b/old_docs/API_docs_v57/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v57/methods/initConnection.md +++ b/old_docs/API_docs_v57/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v57/methods/invokeAfterMsg.md b/old_docs/API_docs_v57/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v57/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v57/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/invokeAfterMsgs.md b/old_docs/API_docs_v57/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v57/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v57/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/invokeWithLayer.md b/old_docs/API_docs_v57/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v57/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v57/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v57/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/messages_addChatUser.md b/old_docs/API_docs_v57/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v57/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v57/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v57/methods/messages_checkChatInvite.md b/old_docs/API_docs_v57/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v57/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v57/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_createChat.md b/old_docs/API_docs_v57/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v57/methods/messages_createChat.md +++ b/old_docs/API_docs_v57/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_deleteChatUser.md b/old_docs/API_docs_v57/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v57/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_deleteHistory.md b/old_docs/API_docs_v57/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v57/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v57/methods/messages_deleteMessages.md b/old_docs/API_docs_v57/methods/messages_deleteMessages.md index 39dbc2ea..2aa9d7d1 100644 --- a/old_docs/API_docs_v57/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v57/methods/messages_deleteMessages.md @@ -11,9 +11,9 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v57/methods/messages_editChatAdmin.md b/old_docs/API_docs_v57/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v57/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_editChatPhoto.md b/old_docs/API_docs_v57/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v57/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_editChatTitle.md b/old_docs/API_docs_v57/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v57/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v57/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v57/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_editMessage.md b/old_docs/API_docs_v57/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v57/methods/messages_editMessage.md +++ b/old_docs/API_docs_v57/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_exportChatInvite.md b/old_docs/API_docs_v57/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v57/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v57/methods/messages_forwardMessage.md b/old_docs/API_docs_v57/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v57/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v57/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_forwardMessages.md b/old_docs/API_docs_v57/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v57/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v57/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_getAllStickers.md b/old_docs/API_docs_v57/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v57/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v57/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v57/methods/messages_getChats.md b/old_docs/API_docs_v57/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v57/methods/messages_getChats.md +++ b/old_docs/API_docs_v57/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v57/methods/messages_getDialogs.md b/old_docs/API_docs_v57/methods/messages_getDialogs.md index 3b03b6c7..557cb7d9 100644 --- a/old_docs/API_docs_v57/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v57/methods/messages_getDialogs.md @@ -11,12 +11,12 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v57/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getGameHighScores.md b/old_docs/API_docs_v57/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v57/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v57/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v57/methods/messages_getHistory.md b/old_docs/API_docs_v57/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v57/methods/messages_getHistory.md +++ b/old_docs/API_docs_v57/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v57/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v57/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMaskStickers.md b/old_docs/API_docs_v57/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v57/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessageEditData.md b/old_docs/API_docs_v57/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v57/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessages.md b/old_docs/API_docs_v57/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessages.md +++ b/old_docs/API_docs_v57/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/messages_getMessagesViews.md b/old_docs/API_docs_v57/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v57/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v57/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v57/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v57/methods/messages_getPeerSettings.md b/old_docs/API_docs_v57/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v57/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v57/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v57/methods/messages_getRecentStickers.md b/old_docs/API_docs_v57/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v57/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v57/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v57/methods/messages_getSavedGifs.md b/old_docs/API_docs_v57/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v57/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v57/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v57/methods/messages_getStickerSet.md b/old_docs/API_docs_v57/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v57/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v57/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v57/methods/messages_hideReportSpam.md b/old_docs/API_docs_v57/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v57/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v57/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_importChatInvite.md b/old_docs/API_docs_v57/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v57/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v57/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_installStickerSet.md b/old_docs/API_docs_v57/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v57/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v57/methods/messages_migrateChat.md b/old_docs/API_docs_v57/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v57/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v57/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v57/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v57/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_readHistory.md b/old_docs/API_docs_v57/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v57/methods/messages_readHistory.md +++ b/old_docs/API_docs_v57/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v57/methods/messages_readMessageContents.md b/old_docs/API_docs_v57/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v57/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v57/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v57/methods/messages_receivedMessages.md b/old_docs/API_docs_v57/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v57/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v57/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v57/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_reportSpam.md b/old_docs/API_docs_v57/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v57/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v57/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_saveDraft.md b/old_docs/API_docs_v57/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v57/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v57/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_saveGif.md b/old_docs/API_docs_v57/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v57/methods/messages_saveGif.md +++ b/old_docs/API_docs_v57/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v57/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_search.md b/old_docs/API_docs_v57/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v57/methods/messages_search.md +++ b/old_docs/API_docs_v57/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/messages_searchGifs.md b/old_docs/API_docs_v57/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v57/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v57/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v57/methods/messages_searchGlobal.md b/old_docs/API_docs_v57/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v57/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v57/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendEncrypted.md b/old_docs/API_docs_v57/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v57/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v57/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_sendMedia.md b/old_docs/API_docs_v57/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v57/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v57/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v57/methods/messages_sendMessage.md b/old_docs/API_docs_v57/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v57/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v57/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md index 41d9fa9e..e75a6d4c 100644 --- a/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v57/methods/messages_setBotCallbackAnswer.md @@ -11,12 +11,12 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v57/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setGameScore.md b/old_docs/API_docs_v57/methods/messages_setGameScore.md index 7fae8bea..0164a532 100644 --- a/old_docs/API_docs_v57/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v57/methods/messages_setGameScore.md @@ -11,13 +11,13 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v57/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md index ea3eebf2..66fd1acd 100644 --- a/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v57/methods/messages_setInlineGameScore.md @@ -11,12 +11,12 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_setTyping.md b/old_docs/API_docs_v57/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v57/methods/messages_setTyping.md +++ b/old_docs/API_docs_v57/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/messages_startBot.md b/old_docs/API_docs_v57/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v57/methods/messages_startBot.md +++ b/old_docs/API_docs_v57/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v57/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v57/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v57/methods/photos_deletePhotos.md b/old_docs/API_docs_v57/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v57/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v57/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v57/methods/photos_getUserPhotos.md b/old_docs/API_docs_v57/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v57/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v57/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v57/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v57/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v57/methods/users_getUsers.md b/old_docs/API_docs_v57/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v57/methods/users_getUsers.md +++ b/old_docs/API_docs_v57/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v62/methods/account_changePhone.md b/old_docs/API_docs_v62/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v62/methods/account_changePhone.md +++ b/old_docs/API_docs_v62/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_checkUsername.md b/old_docs/API_docs_v62/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v62/methods/account_checkUsername.md +++ b/old_docs/API_docs_v62/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_confirmPhone.md b/old_docs/API_docs_v62/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v62/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v62/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_deleteAccount.md b/old_docs/API_docs_v62/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v62/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v62/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_getNotifySettings.md b/old_docs/API_docs_v62/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v62/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v62/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_getPasswordSettings.md b/old_docs/API_docs_v62/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v62/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v62/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_getPrivacy.md b/old_docs/API_docs_v62/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v62/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v62/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_registerDevice.md b/old_docs/API_docs_v62/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v62/methods/account_registerDevice.md +++ b/old_docs/API_docs_v62/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/account_reportPeer.md b/old_docs/API_docs_v62/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v62/methods/account_reportPeer.md +++ b/old_docs/API_docs_v62/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_resetAuthorization.md b/old_docs/API_docs_v62/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v62/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v62/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v62/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v62/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_setAccountTTL.md b/old_docs/API_docs_v62/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v62/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v62/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_setPrivacy.md b/old_docs/API_docs_v62/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v62/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v62/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_unregisterDevice.md b/old_docs/API_docs_v62/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v62/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v62/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v62/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_updateNotifySettings.md b/old_docs/API_docs_v62/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v62/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v62/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v62/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_updateProfile.md b/old_docs/API_docs_v62/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v62/methods/account_updateProfile.md +++ b/old_docs/API_docs_v62/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_updateStatus.md b/old_docs/API_docs_v62/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v62/methods/account_updateStatus.md +++ b/old_docs/API_docs_v62/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/account_updateUsername.md b/old_docs/API_docs_v62/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v62/methods/account_updateUsername.md +++ b/old_docs/API_docs_v62/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/auth_cancelCode.md b/old_docs/API_docs_v62/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v62/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v62/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/auth_checkPhone.md b/old_docs/API_docs_v62/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v62/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v62/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v62/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/auth_recoverPassword.md b/old_docs/API_docs_v62/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v62/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v62/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/auth_resendCode.md b/old_docs/API_docs_v62/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v62/methods/auth_resendCode.md +++ b/old_docs/API_docs_v62/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/auth_sendInvites.md b/old_docs/API_docs_v62/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v62/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v62/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/channels_checkUsername.md b/old_docs/API_docs_v62/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v62/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v62/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_createChannel.md b/old_docs/API_docs_v62/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v62/methods/channels_createChannel.md +++ b/old_docs/API_docs_v62/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_deleteChannel.md b/old_docs/API_docs_v62/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v62/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_deleteMessages.md b/old_docs/API_docs_v62/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v62/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v62/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_editAbout.md b/old_docs/API_docs_v62/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v62/methods/channels_editAbout.md +++ b/old_docs/API_docs_v62/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_editAdmin.md b/old_docs/API_docs_v62/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v62/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v62/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_editPhoto.md b/old_docs/API_docs_v62/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v62/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v62/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_editTitle.md b/old_docs/API_docs_v62/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v62/methods/channels_editTitle.md +++ b/old_docs/API_docs_v62/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_exportInvite.md b/old_docs/API_docs_v62/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v62/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v62/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_exportMessageLink.md b/old_docs/API_docs_v62/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v62/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v62/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v62/methods/channels_getChannels.md b/old_docs/API_docs_v62/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v62/methods/channels_getChannels.md +++ b/old_docs/API_docs_v62/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_getMessages.md b/old_docs/API_docs_v62/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v62/methods/channels_getMessages.md +++ b/old_docs/API_docs_v62/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/channels_getParticipant.md b/old_docs/API_docs_v62/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v62/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v62/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_getParticipants.md b/old_docs/API_docs_v62/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v62/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v62/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v62/methods/channels_inviteToChannel.md b/old_docs/API_docs_v62/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v62/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v62/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_joinChannel.md b/old_docs/API_docs_v62/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v62/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v62/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_kickFromChannel.md b/old_docs/API_docs_v62/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v62/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v62/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/channels_leaveChannel.md b/old_docs/API_docs_v62/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v62/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v62/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_readHistory.md b/old_docs/API_docs_v62/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v62/methods/channels_readHistory.md +++ b/old_docs/API_docs_v62/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_reportSpam.md b/old_docs/API_docs_v62/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v62/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v62/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_toggleInvites.md b/old_docs/API_docs_v62/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v62/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v62/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_toggleSignatures.md b/old_docs/API_docs_v62/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v62/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v62/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v62/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/channels_updateUsername.md b/old_docs/API_docs_v62/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v62/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v62/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_block.md b/old_docs/API_docs_v62/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v62/methods/contacts_block.md +++ b/old_docs/API_docs_v62/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_deleteContact.md b/old_docs/API_docs_v62/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v62/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v62/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_deleteContacts.md b/old_docs/API_docs_v62/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v62/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v62/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_getBlocked.md b/old_docs/API_docs_v62/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v62/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v62/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_getContacts.md b/old_docs/API_docs_v62/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v62/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v62/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v62/methods/contacts_getTopPeers.md b/old_docs/API_docs_v62/methods/contacts_getTopPeers.md index 29dbb3ba..d81bb6ef 100644 --- a/old_docs/API_docs_v62/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v62/methods/contacts_getTopPeers.md @@ -11,16 +11,16 @@ 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?| -|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| +|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) diff --git a/old_docs/API_docs_v62/methods/contacts_importCard.md b/old_docs/API_docs_v62/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v62/methods/contacts_importCard.md +++ b/old_docs/API_docs_v62/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_importContacts.md b/old_docs/API_docs_v62/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v62/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v62/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v62/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_search.md b/old_docs/API_docs_v62/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v62/methods/contacts_search.md +++ b/old_docs/API_docs_v62/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/contacts_unblock.md b/old_docs/API_docs_v62/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v62/methods/contacts_unblock.md +++ b/old_docs/API_docs_v62/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/help_saveAppLog.md b/old_docs/API_docs_v62/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v62/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v62/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v62/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/initConnection.md b/old_docs/API_docs_v62/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v62/methods/initConnection.md +++ b/old_docs/API_docs_v62/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v62/methods/invokeAfterMsg.md b/old_docs/API_docs_v62/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v62/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v62/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/invokeAfterMsgs.md b/old_docs/API_docs_v62/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v62/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v62/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/invokeWithLayer.md b/old_docs/API_docs_v62/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v62/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v62/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v62/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/messages_addChatUser.md b/old_docs/API_docs_v62/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v62/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v62/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v62/methods/messages_checkChatInvite.md b/old_docs/API_docs_v62/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v62/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v62/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_createChat.md b/old_docs/API_docs_v62/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v62/methods/messages_createChat.md +++ b/old_docs/API_docs_v62/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_deleteChatUser.md b/old_docs/API_docs_v62/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v62/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_deleteHistory.md b/old_docs/API_docs_v62/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v62/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v62/methods/messages_deleteMessages.md b/old_docs/API_docs_v62/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v62/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v62/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v62/methods/messages_editChatAdmin.md b/old_docs/API_docs_v62/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v62/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_editChatPhoto.md b/old_docs/API_docs_v62/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v62/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_editChatTitle.md b/old_docs/API_docs_v62/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v62/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v62/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v62/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_editMessage.md b/old_docs/API_docs_v62/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v62/methods/messages_editMessage.md +++ b/old_docs/API_docs_v62/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_exportChatInvite.md b/old_docs/API_docs_v62/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v62/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v62/methods/messages_forwardMessage.md b/old_docs/API_docs_v62/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v62/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v62/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_forwardMessages.md b/old_docs/API_docs_v62/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v62/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v62/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAllChats.md b/old_docs/API_docs_v62/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v62/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAllStickers.md b/old_docs/API_docs_v62/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v62/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v62/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v62/methods/messages_getChats.md b/old_docs/API_docs_v62/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v62/methods/messages_getChats.md +++ b/old_docs/API_docs_v62/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/messages_getCommonChats.md b/old_docs/API_docs_v62/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v62/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v62/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v62/methods/messages_getDialogs.md b/old_docs/API_docs_v62/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v62/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v62/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getGameHighScores.md b/old_docs/API_docs_v62/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v62/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v62/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v62/methods/messages_getHistory.md b/old_docs/API_docs_v62/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v62/methods/messages_getHistory.md +++ b/old_docs/API_docs_v62/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v62/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v62/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMaskStickers.md b/old_docs/API_docs_v62/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v62/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessageEditData.md b/old_docs/API_docs_v62/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v62/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessages.md b/old_docs/API_docs_v62/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessages.md +++ b/old_docs/API_docs_v62/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/messages_getMessagesViews.md b/old_docs/API_docs_v62/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v62/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v62/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getPeerSettings.md b/old_docs/API_docs_v62/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v62/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v62/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v62/methods/messages_getRecentStickers.md b/old_docs/API_docs_v62/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v62/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v62/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v62/methods/messages_getSavedGifs.md b/old_docs/API_docs_v62/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v62/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v62/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v62/methods/messages_getStickerSet.md b/old_docs/API_docs_v62/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v62/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v62/methods/messages_getWebPage.md b/old_docs/API_docs_v62/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v62/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v62/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v62/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v62/methods/messages_hideReportSpam.md b/old_docs/API_docs_v62/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v62/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v62/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_importChatInvite.md b/old_docs/API_docs_v62/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v62/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v62/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_installStickerSet.md b/old_docs/API_docs_v62/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v62/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v62/methods/messages_migrateChat.md b/old_docs/API_docs_v62/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v62/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v62/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v62/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v62/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_readHistory.md b/old_docs/API_docs_v62/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v62/methods/messages_readHistory.md +++ b/old_docs/API_docs_v62/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v62/methods/messages_readMessageContents.md b/old_docs/API_docs_v62/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v62/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v62/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v62/methods/messages_receivedMessages.md b/old_docs/API_docs_v62/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v62/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v62/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v62/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v62/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v62/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_reportSpam.md b/old_docs/API_docs_v62/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v62/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v62/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_saveDraft.md b/old_docs/API_docs_v62/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v62/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v62/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_saveGif.md b/old_docs/API_docs_v62/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v62/methods/messages_saveGif.md +++ b/old_docs/API_docs_v62/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v62/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_search.md b/old_docs/API_docs_v62/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v62/methods/messages_search.md +++ b/old_docs/API_docs_v62/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/messages_searchGifs.md b/old_docs/API_docs_v62/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v62/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v62/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v62/methods/messages_searchGlobal.md b/old_docs/API_docs_v62/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v62/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v62/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendEncrypted.md b/old_docs/API_docs_v62/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v62/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v62/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_sendMedia.md b/old_docs/API_docs_v62/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v62/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v62/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v62/methods/messages_sendMessage.md b/old_docs/API_docs_v62/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v62/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v62/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v62/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v62/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setGameScore.md b/old_docs/API_docs_v62/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v62/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v62/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v62/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v62/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_setTyping.md b/old_docs/API_docs_v62/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v62/methods/messages_setTyping.md +++ b/old_docs/API_docs_v62/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_startBot.md b/old_docs/API_docs_v62/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v62/methods/messages_startBot.md +++ b/old_docs/API_docs_v62/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v62/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v62/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v62/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/phone_receivedCall.md b/old_docs/API_docs_v62/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v62/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v62/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v62/methods/photos_deletePhotos.md b/old_docs/API_docs_v62/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v62/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v62/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v62/methods/photos_getUserPhotos.md b/old_docs/API_docs_v62/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v62/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v62/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v62/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v62/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v62/methods/users_getUsers.md b/old_docs/API_docs_v62/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v62/methods/users_getUsers.md +++ b/old_docs/API_docs_v62/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v65/methods/account_changePhone.md b/old_docs/API_docs_v65/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v65/methods/account_changePhone.md +++ b/old_docs/API_docs_v65/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_checkUsername.md b/old_docs/API_docs_v65/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v65/methods/account_checkUsername.md +++ b/old_docs/API_docs_v65/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_confirmPhone.md b/old_docs/API_docs_v65/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v65/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v65/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_deleteAccount.md b/old_docs/API_docs_v65/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v65/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v65/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_getNotifySettings.md b/old_docs/API_docs_v65/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v65/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v65/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_getPasswordSettings.md b/old_docs/API_docs_v65/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v65/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v65/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_getPrivacy.md b/old_docs/API_docs_v65/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v65/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v65/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_getTmpPassword.md b/old_docs/API_docs_v65/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v65/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v65/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_registerDevice.md b/old_docs/API_docs_v65/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v65/methods/account_registerDevice.md +++ b/old_docs/API_docs_v65/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/account_reportPeer.md b/old_docs/API_docs_v65/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v65/methods/account_reportPeer.md +++ b/old_docs/API_docs_v65/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_resetAuthorization.md b/old_docs/API_docs_v65/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v65/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v65/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v65/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v65/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_setAccountTTL.md b/old_docs/API_docs_v65/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v65/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v65/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_setPrivacy.md b/old_docs/API_docs_v65/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v65/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v65/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_unregisterDevice.md b/old_docs/API_docs_v65/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v65/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v65/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v65/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_updateNotifySettings.md b/old_docs/API_docs_v65/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v65/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v65/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v65/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_updateProfile.md b/old_docs/API_docs_v65/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v65/methods/account_updateProfile.md +++ b/old_docs/API_docs_v65/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_updateStatus.md b/old_docs/API_docs_v65/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v65/methods/account_updateStatus.md +++ b/old_docs/API_docs_v65/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/account_updateUsername.md b/old_docs/API_docs_v65/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v65/methods/account_updateUsername.md +++ b/old_docs/API_docs_v65/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/auth_cancelCode.md b/old_docs/API_docs_v65/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v65/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v65/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/auth_checkPhone.md b/old_docs/API_docs_v65/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v65/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v65/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v65/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/auth_recoverPassword.md b/old_docs/API_docs_v65/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v65/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v65/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/auth_resendCode.md b/old_docs/API_docs_v65/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v65/methods/auth_resendCode.md +++ b/old_docs/API_docs_v65/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/auth_sendInvites.md b/old_docs/API_docs_v65/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v65/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v65/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v65/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v65/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_checkUsername.md b/old_docs/API_docs_v65/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v65/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v65/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_createChannel.md b/old_docs/API_docs_v65/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v65/methods/channels_createChannel.md +++ b/old_docs/API_docs_v65/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_deleteChannel.md b/old_docs/API_docs_v65/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v65/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_deleteMessages.md b/old_docs/API_docs_v65/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v65/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v65/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_editAbout.md b/old_docs/API_docs_v65/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v65/methods/channels_editAbout.md +++ b/old_docs/API_docs_v65/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_editAdmin.md b/old_docs/API_docs_v65/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v65/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v65/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_editPhoto.md b/old_docs/API_docs_v65/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v65/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v65/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_editTitle.md b/old_docs/API_docs_v65/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v65/methods/channels_editTitle.md +++ b/old_docs/API_docs_v65/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_exportInvite.md b/old_docs/API_docs_v65/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v65/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v65/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_exportMessageLink.md b/old_docs/API_docs_v65/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v65/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v65/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v65/methods/channels_getChannels.md b/old_docs/API_docs_v65/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v65/methods/channels_getChannels.md +++ b/old_docs/API_docs_v65/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_getMessages.md b/old_docs/API_docs_v65/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v65/methods/channels_getMessages.md +++ b/old_docs/API_docs_v65/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/channels_getParticipant.md b/old_docs/API_docs_v65/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v65/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v65/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_getParticipants.md b/old_docs/API_docs_v65/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v65/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v65/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v65/methods/channels_inviteToChannel.md b/old_docs/API_docs_v65/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v65/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v65/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_joinChannel.md b/old_docs/API_docs_v65/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v65/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v65/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_kickFromChannel.md b/old_docs/API_docs_v65/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v65/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v65/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/channels_leaveChannel.md b/old_docs/API_docs_v65/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v65/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v65/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_readHistory.md b/old_docs/API_docs_v65/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v65/methods/channels_readHistory.md +++ b/old_docs/API_docs_v65/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_reportSpam.md b/old_docs/API_docs_v65/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v65/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v65/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_toggleInvites.md b/old_docs/API_docs_v65/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v65/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v65/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_toggleSignatures.md b/old_docs/API_docs_v65/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v65/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v65/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/channels_updateUsername.md b/old_docs/API_docs_v65/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v65/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v65/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_block.md b/old_docs/API_docs_v65/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v65/methods/contacts_block.md +++ b/old_docs/API_docs_v65/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_deleteContact.md b/old_docs/API_docs_v65/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v65/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v65/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_deleteContacts.md b/old_docs/API_docs_v65/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v65/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v65/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_getBlocked.md b/old_docs/API_docs_v65/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v65/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v65/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_getContacts.md b/old_docs/API_docs_v65/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v65/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v65/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v65/methods/contacts_getTopPeers.md b/old_docs/API_docs_v65/methods/contacts_getTopPeers.md index 29dbb3ba..d81bb6ef 100644 --- a/old_docs/API_docs_v65/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v65/methods/contacts_getTopPeers.md @@ -11,16 +11,16 @@ 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?| -|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| +|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) diff --git a/old_docs/API_docs_v65/methods/contacts_importCard.md b/old_docs/API_docs_v65/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v65/methods/contacts_importCard.md +++ b/old_docs/API_docs_v65/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_importContacts.md b/old_docs/API_docs_v65/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v65/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v65/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v65/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_search.md b/old_docs/API_docs_v65/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v65/methods/contacts_search.md +++ b/old_docs/API_docs_v65/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contacts_unblock.md b/old_docs/API_docs_v65/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v65/methods/contacts_unblock.md +++ b/old_docs/API_docs_v65/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md index 4b391435..5761cdc8 100644 --- a/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v65/methods/contest_saveDeveloperInfo.md @@ -11,13 +11,13 @@ Save developer info for telegram contest ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|vk\_id|[int](../types/int.md) | Yes|VK user ID| -|name|[string](../types/string.md) | Yes|Name| -|phone\_number|[string](../types/string.md) | Yes|Phone number| -|age|[int](../types/int.md) | Yes|Age| -|city|[string](../types/string.md) | Yes|City| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|vk\_id|[int](../types/int.md) | VK user ID | Yes| +|name|[string](../types/string.md) | Name | Yes| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|age|[int](../types/int.md) | Age | Yes| +|city|[string](../types/string.md) | City | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/destroy_session.md b/old_docs/API_docs_v65/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/old_docs/API_docs_v65/methods/destroy_session.md +++ b/old_docs/API_docs_v65/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v65/methods/get_future_salts.md b/old_docs/API_docs_v65/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/old_docs/API_docs_v65/methods/get_future_salts.md +++ b/old_docs/API_docs_v65/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v65/methods/help_getAppChangelog.md b/old_docs/API_docs_v65/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v65/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v65/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/help_saveAppLog.md b/old_docs/API_docs_v65/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v65/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v65/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/initConnection.md b/old_docs/API_docs_v65/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v65/methods/initConnection.md +++ b/old_docs/API_docs_v65/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v65/methods/invokeAfterMsg.md b/old_docs/API_docs_v65/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v65/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v65/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/invokeAfterMsgs.md b/old_docs/API_docs_v65/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v65/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v65/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/invokeWithLayer.md b/old_docs/API_docs_v65/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v65/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v65/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v65/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/messages_addChatUser.md b/old_docs/API_docs_v65/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v65/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v65/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v65/methods/messages_checkChatInvite.md b/old_docs/API_docs_v65/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v65/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v65/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_createChat.md b/old_docs/API_docs_v65/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v65/methods/messages_createChat.md +++ b/old_docs/API_docs_v65/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_deleteChatUser.md b/old_docs/API_docs_v65/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v65/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_deleteHistory.md b/old_docs/API_docs_v65/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v65/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v65/methods/messages_deleteMessages.md b/old_docs/API_docs_v65/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v65/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v65/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v65/methods/messages_editChatAdmin.md b/old_docs/API_docs_v65/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v65/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_editChatPhoto.md b/old_docs/API_docs_v65/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v65/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_editChatTitle.md b/old_docs/API_docs_v65/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v65/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v65/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v65/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_editMessage.md b/old_docs/API_docs_v65/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v65/methods/messages_editMessage.md +++ b/old_docs/API_docs_v65/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_exportChatInvite.md b/old_docs/API_docs_v65/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v65/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v65/methods/messages_forwardMessage.md b/old_docs/API_docs_v65/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v65/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v65/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_forwardMessages.md b/old_docs/API_docs_v65/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v65/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v65/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAllChats.md b/old_docs/API_docs_v65/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v65/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAllStickers.md b/old_docs/API_docs_v65/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v65/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v65/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v65/methods/messages_getChats.md b/old_docs/API_docs_v65/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v65/methods/messages_getChats.md +++ b/old_docs/API_docs_v65/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/messages_getCommonChats.md b/old_docs/API_docs_v65/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v65/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v65/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v65/methods/messages_getDialogs.md b/old_docs/API_docs_v65/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v65/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v65/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getGameHighScores.md b/old_docs/API_docs_v65/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v65/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v65/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v65/methods/messages_getHistory.md b/old_docs/API_docs_v65/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v65/methods/messages_getHistory.md +++ b/old_docs/API_docs_v65/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v65/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v65/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMaskStickers.md b/old_docs/API_docs_v65/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v65/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessageEditData.md b/old_docs/API_docs_v65/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v65/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessages.md b/old_docs/API_docs_v65/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessages.md +++ b/old_docs/API_docs_v65/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/messages_getMessagesViews.md b/old_docs/API_docs_v65/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v65/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v65/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getPeerSettings.md b/old_docs/API_docs_v65/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v65/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v65/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v65/methods/messages_getRecentStickers.md b/old_docs/API_docs_v65/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v65/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v65/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v65/methods/messages_getSavedGifs.md b/old_docs/API_docs_v65/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v65/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v65/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v65/methods/messages_getStickerSet.md b/old_docs/API_docs_v65/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v65/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v65/methods/messages_getWebPage.md b/old_docs/API_docs_v65/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v65/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v65/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v65/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v65/methods/messages_hideReportSpam.md b/old_docs/API_docs_v65/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v65/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v65/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_importChatInvite.md b/old_docs/API_docs_v65/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v65/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v65/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_installStickerSet.md b/old_docs/API_docs_v65/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v65/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v65/methods/messages_migrateChat.md b/old_docs/API_docs_v65/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v65/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v65/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v65/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v65/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_readHistory.md b/old_docs/API_docs_v65/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v65/methods/messages_readHistory.md +++ b/old_docs/API_docs_v65/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v65/methods/messages_readMessageContents.md b/old_docs/API_docs_v65/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v65/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v65/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v65/methods/messages_receivedMessages.md b/old_docs/API_docs_v65/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v65/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v65/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v65/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v65/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v65/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_reportSpam.md b/old_docs/API_docs_v65/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v65/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v65/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_saveDraft.md b/old_docs/API_docs_v65/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v65/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v65/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_saveGif.md b/old_docs/API_docs_v65/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v65/methods/messages_saveGif.md +++ b/old_docs/API_docs_v65/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v65/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_search.md b/old_docs/API_docs_v65/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v65/methods/messages_search.md +++ b/old_docs/API_docs_v65/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/messages_searchGifs.md b/old_docs/API_docs_v65/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v65/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v65/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v65/methods/messages_searchGlobal.md b/old_docs/API_docs_v65/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v65/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v65/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendEncrypted.md b/old_docs/API_docs_v65/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v65/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v65/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_sendMedia.md b/old_docs/API_docs_v65/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v65/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v65/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v65/methods/messages_sendMessage.md b/old_docs/API_docs_v65/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v65/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v65/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v65/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v65/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v65/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v65/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setGameScore.md b/old_docs/API_docs_v65/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v65/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v65/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v65/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v65/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_setTyping.md b/old_docs/API_docs_v65/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v65/methods/messages_setTyping.md +++ b/old_docs/API_docs_v65/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_startBot.md b/old_docs/API_docs_v65/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v65/methods/messages_startBot.md +++ b/old_docs/API_docs_v65/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v65/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v65/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v65/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/payments_getPaymentForm.md b/old_docs/API_docs_v65/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v65/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v65/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v65/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v65/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v65/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v65/methods/phone_receivedCall.md b/old_docs/API_docs_v65/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v65/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v65/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/phone_saveCallDebug.md b/old_docs/API_docs_v65/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v65/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v65/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v65/methods/phone_setCallRating.md b/old_docs/API_docs_v65/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v65/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v65/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v65/methods/photos_deletePhotos.md b/old_docs/API_docs_v65/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v65/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v65/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v65/methods/photos_getUserPhotos.md b/old_docs/API_docs_v65/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v65/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v65/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v65/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v65/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v65/methods/ping.md b/old_docs/API_docs_v65/methods/ping.md index dadae42f..d07839e4 100644 --- a/old_docs/API_docs_v65/methods/ping.md +++ b/old_docs/API_docs_v65/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v65/methods/ping_delay_disconnect.md b/old_docs/API_docs_v65/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/old_docs/API_docs_v65/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v65/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v65/methods/req_DH_params.md b/old_docs/API_docs_v65/methods/req_DH_params.md index 89140510..54dd35a0 100644 --- a/old_docs/API_docs_v65/methods/req_DH_params.md +++ b/old_docs/API_docs_v65/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[string](../types/string.md) | Yes|factorized p from pq| -|q|[string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[string](../types/string.md) | factorized p from pq | Yes| +|q|[string](../types/string.md) | factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v65/methods/req_pq.md b/old_docs/API_docs_v65/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/old_docs/API_docs_v65/methods/req_pq.md +++ b/old_docs/API_docs_v65/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v65/methods/rpc_drop_answer.md b/old_docs/API_docs_v65/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/old_docs/API_docs_v65/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v65/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v65/methods/set_client_DH_params.md b/old_docs/API_docs_v65/methods/set_client_DH_params.md index 79a43a88..41bbb00f 100644 --- a/old_docs/API_docs_v65/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v65/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v65/methods/upload_getWebFile.md b/old_docs/API_docs_v65/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v65/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v65/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v65/methods/users_getUsers.md b/old_docs/API_docs_v65/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v65/methods/users_getUsers.md +++ b/old_docs/API_docs_v65/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v66/methods/account_changePhone.md b/old_docs/API_docs_v66/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v66/methods/account_changePhone.md +++ b/old_docs/API_docs_v66/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_checkUsername.md b/old_docs/API_docs_v66/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v66/methods/account_checkUsername.md +++ b/old_docs/API_docs_v66/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_confirmPhone.md b/old_docs/API_docs_v66/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v66/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v66/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_deleteAccount.md b/old_docs/API_docs_v66/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v66/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v66/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_getNotifySettings.md b/old_docs/API_docs_v66/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v66/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v66/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_getPasswordSettings.md b/old_docs/API_docs_v66/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v66/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v66/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_getPrivacy.md b/old_docs/API_docs_v66/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v66/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v66/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_getTmpPassword.md b/old_docs/API_docs_v66/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v66/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v66/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_registerDevice.md b/old_docs/API_docs_v66/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v66/methods/account_registerDevice.md +++ b/old_docs/API_docs_v66/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/account_reportPeer.md b/old_docs/API_docs_v66/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v66/methods/account_reportPeer.md +++ b/old_docs/API_docs_v66/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_resetAuthorization.md b/old_docs/API_docs_v66/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v66/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v66/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v66/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v66/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_setAccountTTL.md b/old_docs/API_docs_v66/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v66/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v66/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_setPrivacy.md b/old_docs/API_docs_v66/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v66/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v66/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_unregisterDevice.md b/old_docs/API_docs_v66/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v66/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v66/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v66/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_updateNotifySettings.md b/old_docs/API_docs_v66/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v66/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v66/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v66/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_updateProfile.md b/old_docs/API_docs_v66/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v66/methods/account_updateProfile.md +++ b/old_docs/API_docs_v66/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_updateStatus.md b/old_docs/API_docs_v66/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v66/methods/account_updateStatus.md +++ b/old_docs/API_docs_v66/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/account_updateUsername.md b/old_docs/API_docs_v66/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v66/methods/account_updateUsername.md +++ b/old_docs/API_docs_v66/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/auth_cancelCode.md b/old_docs/API_docs_v66/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v66/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v66/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/auth_checkPhone.md b/old_docs/API_docs_v66/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v66/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v66/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v66/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/auth_recoverPassword.md b/old_docs/API_docs_v66/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v66/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v66/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/auth_resendCode.md b/old_docs/API_docs_v66/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v66/methods/auth_resendCode.md +++ b/old_docs/API_docs_v66/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/auth_sendInvites.md b/old_docs/API_docs_v66/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v66/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v66/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v66/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v66/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_checkUsername.md b/old_docs/API_docs_v66/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v66/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v66/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_createChannel.md b/old_docs/API_docs_v66/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v66/methods/channels_createChannel.md +++ b/old_docs/API_docs_v66/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_deleteChannel.md b/old_docs/API_docs_v66/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v66/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_deleteMessages.md b/old_docs/API_docs_v66/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v66/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v66/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_editAbout.md b/old_docs/API_docs_v66/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v66/methods/channels_editAbout.md +++ b/old_docs/API_docs_v66/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_editAdmin.md b/old_docs/API_docs_v66/methods/channels_editAdmin.md index c8efb6cc..bc0793fe 100644 --- a/old_docs/API_docs_v66/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v66/methods/channels_editAdmin.md @@ -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| -|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | Yes|User role| +| 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| +|role|[ChannelParticipantRole](../types/ChannelParticipantRole.md) | User role | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_editPhoto.md b/old_docs/API_docs_v66/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v66/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v66/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_editTitle.md b/old_docs/API_docs_v66/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v66/methods/channels_editTitle.md +++ b/old_docs/API_docs_v66/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_exportInvite.md b/old_docs/API_docs_v66/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v66/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v66/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_exportMessageLink.md b/old_docs/API_docs_v66/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v66/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v66/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v66/methods/channels_getChannels.md b/old_docs/API_docs_v66/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v66/methods/channels_getChannels.md +++ b/old_docs/API_docs_v66/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_getMessages.md b/old_docs/API_docs_v66/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v66/methods/channels_getMessages.md +++ b/old_docs/API_docs_v66/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/channels_getParticipant.md b/old_docs/API_docs_v66/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v66/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v66/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_getParticipants.md b/old_docs/API_docs_v66/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v66/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v66/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v66/methods/channels_inviteToChannel.md b/old_docs/API_docs_v66/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v66/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v66/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_joinChannel.md b/old_docs/API_docs_v66/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v66/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v66/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_kickFromChannel.md b/old_docs/API_docs_v66/methods/channels_kickFromChannel.md index 74b703b0..c51cea7c 100644 --- a/old_docs/API_docs_v66/methods/channels_kickFromChannel.md +++ b/old_docs/API_docs_v66/methods/channels_kickFromChannel.md @@ -11,11 +11,11 @@ Kick user from channel ### 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 to kick| -|kicked|[Bool](../types/Bool.md) | Yes|Kick or unkick?| +| 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 to kick | Optional| +|kicked|[Bool](../types/Bool.md) | Kick or unkick? | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/channels_leaveChannel.md b/old_docs/API_docs_v66/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v66/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v66/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_readHistory.md b/old_docs/API_docs_v66/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v66/methods/channels_readHistory.md +++ b/old_docs/API_docs_v66/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_reportSpam.md b/old_docs/API_docs_v66/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v66/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v66/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_toggleInvites.md b/old_docs/API_docs_v66/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v66/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v66/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_toggleSignatures.md b/old_docs/API_docs_v66/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v66/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v66/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v66/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/channels_updateUsername.md b/old_docs/API_docs_v66/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v66/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v66/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_block.md b/old_docs/API_docs_v66/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v66/methods/contacts_block.md +++ b/old_docs/API_docs_v66/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_deleteContact.md b/old_docs/API_docs_v66/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v66/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v66/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_deleteContacts.md b/old_docs/API_docs_v66/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v66/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v66/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_getBlocked.md b/old_docs/API_docs_v66/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v66/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v66/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_getContacts.md b/old_docs/API_docs_v66/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v66/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v66/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v66/methods/contacts_getTopPeers.md b/old_docs/API_docs_v66/methods/contacts_getTopPeers.md index 29dbb3ba..d81bb6ef 100644 --- a/old_docs/API_docs_v66/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v66/methods/contacts_getTopPeers.md @@ -11,16 +11,16 @@ 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?| -|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| +|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) diff --git a/old_docs/API_docs_v66/methods/contacts_importCard.md b/old_docs/API_docs_v66/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v66/methods/contacts_importCard.md +++ b/old_docs/API_docs_v66/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_importContacts.md b/old_docs/API_docs_v66/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v66/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v66/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v66/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_search.md b/old_docs/API_docs_v66/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v66/methods/contacts_search.md +++ b/old_docs/API_docs_v66/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contacts_unblock.md b/old_docs/API_docs_v66/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v66/methods/contacts_unblock.md +++ b/old_docs/API_docs_v66/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md index 4b391435..5761cdc8 100644 --- a/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v66/methods/contest_saveDeveloperInfo.md @@ -11,13 +11,13 @@ Save developer info for telegram contest ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|vk\_id|[int](../types/int.md) | Yes|VK user ID| -|name|[string](../types/string.md) | Yes|Name| -|phone\_number|[string](../types/string.md) | Yes|Phone number| -|age|[int](../types/int.md) | Yes|Age| -|city|[string](../types/string.md) | Yes|City| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|vk\_id|[int](../types/int.md) | VK user ID | Yes| +|name|[string](../types/string.md) | Name | Yes| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|age|[int](../types/int.md) | Age | Yes| +|city|[string](../types/string.md) | City | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/destroy_session.md b/old_docs/API_docs_v66/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/old_docs/API_docs_v66/methods/destroy_session.md +++ b/old_docs/API_docs_v66/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v66/methods/get_future_salts.md b/old_docs/API_docs_v66/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/old_docs/API_docs_v66/methods/get_future_salts.md +++ b/old_docs/API_docs_v66/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v66/methods/help_getAppChangelog.md b/old_docs/API_docs_v66/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v66/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v66/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/help_saveAppLog.md b/old_docs/API_docs_v66/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v66/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v66/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v66/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/initConnection.md b/old_docs/API_docs_v66/methods/initConnection.md index c3f04262..58cdb067 100644 --- a/old_docs/API_docs_v66/methods/initConnection.md +++ b/old_docs/API_docs_v66/methods/initConnection.md @@ -11,14 +11,14 @@ 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| -|lang\_code|[string](../types/string.md) | Yes|Language code to set| -|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| +|lang\_code|[string](../types/string.md) | Language code to set | Yes| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v66/methods/invokeAfterMsg.md b/old_docs/API_docs_v66/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v66/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v66/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/invokeAfterMsgs.md b/old_docs/API_docs_v66/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v66/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v66/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/invokeWithLayer.md b/old_docs/API_docs_v66/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v66/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v66/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v66/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/messages_addChatUser.md b/old_docs/API_docs_v66/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v66/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v66/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v66/methods/messages_checkChatInvite.md b/old_docs/API_docs_v66/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v66/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v66/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_createChat.md b/old_docs/API_docs_v66/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v66/methods/messages_createChat.md +++ b/old_docs/API_docs_v66/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_deleteChatUser.md b/old_docs/API_docs_v66/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v66/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_deleteHistory.md b/old_docs/API_docs_v66/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v66/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v66/methods/messages_deleteMessages.md b/old_docs/API_docs_v66/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v66/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v66/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v66/methods/messages_editChatAdmin.md b/old_docs/API_docs_v66/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v66/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_editChatPhoto.md b/old_docs/API_docs_v66/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v66/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_editChatTitle.md b/old_docs/API_docs_v66/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v66/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v66/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v66/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_editMessage.md b/old_docs/API_docs_v66/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v66/methods/messages_editMessage.md +++ b/old_docs/API_docs_v66/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_exportChatInvite.md b/old_docs/API_docs_v66/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v66/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v66/methods/messages_forwardMessage.md b/old_docs/API_docs_v66/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v66/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v66/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_forwardMessages.md b/old_docs/API_docs_v66/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v66/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v66/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAllChats.md b/old_docs/API_docs_v66/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v66/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAllStickers.md b/old_docs/API_docs_v66/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v66/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v66/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v66/methods/messages_getChats.md b/old_docs/API_docs_v66/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v66/methods/messages_getChats.md +++ b/old_docs/API_docs_v66/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/messages_getCommonChats.md b/old_docs/API_docs_v66/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v66/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v66/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v66/methods/messages_getDialogs.md b/old_docs/API_docs_v66/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v66/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v66/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getGameHighScores.md b/old_docs/API_docs_v66/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v66/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v66/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v66/methods/messages_getHistory.md b/old_docs/API_docs_v66/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v66/methods/messages_getHistory.md +++ b/old_docs/API_docs_v66/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v66/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v66/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMaskStickers.md b/old_docs/API_docs_v66/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v66/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessageEditData.md b/old_docs/API_docs_v66/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v66/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessages.md b/old_docs/API_docs_v66/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessages.md +++ b/old_docs/API_docs_v66/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/messages_getMessagesViews.md b/old_docs/API_docs_v66/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v66/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v66/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getPeerSettings.md b/old_docs/API_docs_v66/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v66/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v66/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v66/methods/messages_getRecentStickers.md b/old_docs/API_docs_v66/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v66/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v66/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v66/methods/messages_getSavedGifs.md b/old_docs/API_docs_v66/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v66/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v66/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v66/methods/messages_getStickerSet.md b/old_docs/API_docs_v66/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v66/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v66/methods/messages_getWebPage.md b/old_docs/API_docs_v66/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v66/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v66/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v66/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v66/methods/messages_hideReportSpam.md b/old_docs/API_docs_v66/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v66/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v66/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_importChatInvite.md b/old_docs/API_docs_v66/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v66/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v66/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_installStickerSet.md b/old_docs/API_docs_v66/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v66/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v66/methods/messages_migrateChat.md b/old_docs/API_docs_v66/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v66/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v66/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v66/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v66/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_readHistory.md b/old_docs/API_docs_v66/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v66/methods/messages_readHistory.md +++ b/old_docs/API_docs_v66/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v66/methods/messages_readMessageContents.md b/old_docs/API_docs_v66/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v66/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v66/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v66/methods/messages_receivedMessages.md b/old_docs/API_docs_v66/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v66/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v66/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v66/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v66/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v66/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_reportSpam.md b/old_docs/API_docs_v66/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v66/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v66/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_saveDraft.md b/old_docs/API_docs_v66/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v66/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v66/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_saveGif.md b/old_docs/API_docs_v66/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v66/methods/messages_saveGif.md +++ b/old_docs/API_docs_v66/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v66/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_search.md b/old_docs/API_docs_v66/methods/messages_search.md index df482938..46a5ad5e 100644 --- a/old_docs/API_docs_v66/methods/messages_search.md +++ b/old_docs/API_docs_v66/methods/messages_search.md @@ -11,16 +11,16 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/messages_searchGifs.md b/old_docs/API_docs_v66/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v66/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v66/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v66/methods/messages_searchGlobal.md b/old_docs/API_docs_v66/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v66/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v66/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendEncrypted.md b/old_docs/API_docs_v66/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v66/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v66/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_sendMedia.md b/old_docs/API_docs_v66/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v66/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v66/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v66/methods/messages_sendMessage.md b/old_docs/API_docs_v66/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v66/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v66/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v66/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v66/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v66/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v66/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setGameScore.md b/old_docs/API_docs_v66/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v66/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v66/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v66/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v66/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_setTyping.md b/old_docs/API_docs_v66/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v66/methods/messages_setTyping.md +++ b/old_docs/API_docs_v66/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_startBot.md b/old_docs/API_docs_v66/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v66/methods/messages_startBot.md +++ b/old_docs/API_docs_v66/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v66/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v66/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v66/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/payments_getPaymentForm.md b/old_docs/API_docs_v66/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v66/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v66/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v66/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v66/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v66/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v66/methods/phone_receivedCall.md b/old_docs/API_docs_v66/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v66/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v66/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/phone_saveCallDebug.md b/old_docs/API_docs_v66/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v66/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v66/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v66/methods/phone_setCallRating.md b/old_docs/API_docs_v66/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v66/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v66/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v66/methods/photos_deletePhotos.md b/old_docs/API_docs_v66/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v66/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v66/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v66/methods/photos_getUserPhotos.md b/old_docs/API_docs_v66/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v66/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v66/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v66/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v66/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v66/methods/ping.md b/old_docs/API_docs_v66/methods/ping.md index dadae42f..d07839e4 100644 --- a/old_docs/API_docs_v66/methods/ping.md +++ b/old_docs/API_docs_v66/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v66/methods/ping_delay_disconnect.md b/old_docs/API_docs_v66/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/old_docs/API_docs_v66/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v66/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v66/methods/req_DH_params.md b/old_docs/API_docs_v66/methods/req_DH_params.md index 89140510..54dd35a0 100644 --- a/old_docs/API_docs_v66/methods/req_DH_params.md +++ b/old_docs/API_docs_v66/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[string](../types/string.md) | Yes|factorized p from pq| -|q|[string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[string](../types/string.md) | factorized p from pq | Yes| +|q|[string](../types/string.md) | factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v66/methods/req_pq.md b/old_docs/API_docs_v66/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/old_docs/API_docs_v66/methods/req_pq.md +++ b/old_docs/API_docs_v66/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v66/methods/rpc_drop_answer.md b/old_docs/API_docs_v66/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/old_docs/API_docs_v66/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v66/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v66/methods/set_client_DH_params.md b/old_docs/API_docs_v66/methods/set_client_DH_params.md index 79a43a88..41bbb00f 100644 --- a/old_docs/API_docs_v66/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v66/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v66/methods/upload_getWebFile.md b/old_docs/API_docs_v66/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v66/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v66/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v66/methods/users_getUsers.md b/old_docs/API_docs_v66/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v66/methods/users_getUsers.md +++ b/old_docs/API_docs_v66/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v68/methods/account_changePhone.md b/old_docs/API_docs_v68/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v68/methods/account_changePhone.md +++ b/old_docs/API_docs_v68/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_checkUsername.md b/old_docs/API_docs_v68/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v68/methods/account_checkUsername.md +++ b/old_docs/API_docs_v68/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_confirmPhone.md b/old_docs/API_docs_v68/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v68/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v68/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_deleteAccount.md b/old_docs/API_docs_v68/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v68/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v68/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_getNotifySettings.md b/old_docs/API_docs_v68/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v68/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v68/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_getPasswordSettings.md b/old_docs/API_docs_v68/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v68/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v68/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_getPrivacy.md b/old_docs/API_docs_v68/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v68/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v68/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_getTmpPassword.md b/old_docs/API_docs_v68/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v68/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v68/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_registerDevice.md b/old_docs/API_docs_v68/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v68/methods/account_registerDevice.md +++ b/old_docs/API_docs_v68/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/account_reportPeer.md b/old_docs/API_docs_v68/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v68/methods/account_reportPeer.md +++ b/old_docs/API_docs_v68/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_resetAuthorization.md b/old_docs/API_docs_v68/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v68/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v68/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v68/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v68/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_setAccountTTL.md b/old_docs/API_docs_v68/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v68/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v68/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_setPrivacy.md b/old_docs/API_docs_v68/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v68/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v68/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_unregisterDevice.md b/old_docs/API_docs_v68/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v68/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v68/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v68/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_updateNotifySettings.md b/old_docs/API_docs_v68/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v68/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v68/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v68/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_updateProfile.md b/old_docs/API_docs_v68/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v68/methods/account_updateProfile.md +++ b/old_docs/API_docs_v68/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_updateStatus.md b/old_docs/API_docs_v68/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v68/methods/account_updateStatus.md +++ b/old_docs/API_docs_v68/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/account_updateUsername.md b/old_docs/API_docs_v68/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v68/methods/account_updateUsername.md +++ b/old_docs/API_docs_v68/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/auth_cancelCode.md b/old_docs/API_docs_v68/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v68/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v68/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/auth_checkPhone.md b/old_docs/API_docs_v68/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v68/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v68/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v68/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/auth_recoverPassword.md b/old_docs/API_docs_v68/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v68/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v68/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/auth_resendCode.md b/old_docs/API_docs_v68/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v68/methods/auth_resendCode.md +++ b/old_docs/API_docs_v68/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/auth_sendInvites.md b/old_docs/API_docs_v68/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v68/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v68/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v68/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v68/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_checkUsername.md b/old_docs/API_docs_v68/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v68/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v68/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_createChannel.md b/old_docs/API_docs_v68/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v68/methods/channels_createChannel.md +++ b/old_docs/API_docs_v68/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_deleteChannel.md b/old_docs/API_docs_v68/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v68/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_deleteMessages.md b/old_docs/API_docs_v68/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v68/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v68/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_editAbout.md b/old_docs/API_docs_v68/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v68/methods/channels_editAbout.md +++ b/old_docs/API_docs_v68/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_editAdmin.md b/old_docs/API_docs_v68/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v68/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v68/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_editBanned.md b/old_docs/API_docs_v68/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v68/methods/channels_editBanned.md +++ b/old_docs/API_docs_v68/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_editPhoto.md b/old_docs/API_docs_v68/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v68/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v68/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_editTitle.md b/old_docs/API_docs_v68/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v68/methods/channels_editTitle.md +++ b/old_docs/API_docs_v68/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_exportInvite.md b/old_docs/API_docs_v68/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v68/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v68/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_exportMessageLink.md b/old_docs/API_docs_v68/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v68/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v68/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v68/methods/channels_getAdminLog.md b/old_docs/API_docs_v68/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v68/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v68/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_getChannels.md b/old_docs/API_docs_v68/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v68/methods/channels_getChannels.md +++ b/old_docs/API_docs_v68/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_getMessages.md b/old_docs/API_docs_v68/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v68/methods/channels_getMessages.md +++ b/old_docs/API_docs_v68/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/channels_getParticipant.md b/old_docs/API_docs_v68/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v68/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v68/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_getParticipants.md b/old_docs/API_docs_v68/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v68/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v68/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v68/methods/channels_inviteToChannel.md b/old_docs/API_docs_v68/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v68/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v68/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_joinChannel.md b/old_docs/API_docs_v68/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v68/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v68/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_leaveChannel.md b/old_docs/API_docs_v68/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v68/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v68/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_readHistory.md b/old_docs/API_docs_v68/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v68/methods/channels_readHistory.md +++ b/old_docs/API_docs_v68/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_reportSpam.md b/old_docs/API_docs_v68/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v68/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v68/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_toggleInvites.md b/old_docs/API_docs_v68/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v68/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v68/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_toggleSignatures.md b/old_docs/API_docs_v68/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v68/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v68/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v68/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/channels_updateUsername.md b/old_docs/API_docs_v68/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v68/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v68/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_block.md b/old_docs/API_docs_v68/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v68/methods/contacts_block.md +++ b/old_docs/API_docs_v68/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_deleteContact.md b/old_docs/API_docs_v68/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v68/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v68/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_deleteContacts.md b/old_docs/API_docs_v68/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v68/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v68/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_getBlocked.md b/old_docs/API_docs_v68/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v68/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v68/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_getContacts.md b/old_docs/API_docs_v68/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v68/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v68/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v68/methods/contacts_getTopPeers.md b/old_docs/API_docs_v68/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v68/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v68/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_importCard.md b/old_docs/API_docs_v68/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v68/methods/contacts_importCard.md +++ b/old_docs/API_docs_v68/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_importContacts.md b/old_docs/API_docs_v68/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v68/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v68/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v68/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_search.md b/old_docs/API_docs_v68/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v68/methods/contacts_search.md +++ b/old_docs/API_docs_v68/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contacts_unblock.md b/old_docs/API_docs_v68/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v68/methods/contacts_unblock.md +++ b/old_docs/API_docs_v68/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md index 4b391435..5761cdc8 100644 --- a/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v68/methods/contest_saveDeveloperInfo.md @@ -11,13 +11,13 @@ Save developer info for telegram contest ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|vk\_id|[int](../types/int.md) | Yes|VK user ID| -|name|[string](../types/string.md) | Yes|Name| -|phone\_number|[string](../types/string.md) | Yes|Phone number| -|age|[int](../types/int.md) | Yes|Age| -|city|[string](../types/string.md) | Yes|City| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|vk\_id|[int](../types/int.md) | VK user ID | Yes| +|name|[string](../types/string.md) | Name | Yes| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|age|[int](../types/int.md) | Age | Yes| +|city|[string](../types/string.md) | City | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/destroy_session.md b/old_docs/API_docs_v68/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/old_docs/API_docs_v68/methods/destroy_session.md +++ b/old_docs/API_docs_v68/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v68/methods/get_future_salts.md b/old_docs/API_docs_v68/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/old_docs/API_docs_v68/methods/get_future_salts.md +++ b/old_docs/API_docs_v68/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v68/methods/help_getAppChangelog.md b/old_docs/API_docs_v68/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v68/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v68/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/help_saveAppLog.md b/old_docs/API_docs_v68/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v68/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v68/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v68/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/initConnection.md b/old_docs/API_docs_v68/methods/initConnection.md index de4c0c00..692a41e8 100644 --- a/old_docs/API_docs_v68/methods/initConnection.md +++ b/old_docs/API_docs_v68/methods/initConnection.md @@ -11,16 +11,16 @@ 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| -|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| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v68/methods/invokeAfterMsg.md b/old_docs/API_docs_v68/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v68/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v68/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/invokeAfterMsgs.md b/old_docs/API_docs_v68/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v68/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v68/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/invokeWithLayer.md b/old_docs/API_docs_v68/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v68/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v68/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v68/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/langpack_getDifference.md b/old_docs/API_docs_v68/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v68/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v68/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/langpack_getLangPack.md b/old_docs/API_docs_v68/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v68/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v68/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/langpack_getStrings.md b/old_docs/API_docs_v68/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v68/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v68/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/messages_addChatUser.md b/old_docs/API_docs_v68/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v68/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v68/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v68/methods/messages_checkChatInvite.md b/old_docs/API_docs_v68/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v68/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v68/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_createChat.md b/old_docs/API_docs_v68/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v68/methods/messages_createChat.md +++ b/old_docs/API_docs_v68/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_deleteChatUser.md b/old_docs/API_docs_v68/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v68/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_deleteHistory.md b/old_docs/API_docs_v68/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v68/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v68/methods/messages_deleteMessages.md b/old_docs/API_docs_v68/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v68/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v68/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v68/methods/messages_editChatAdmin.md b/old_docs/API_docs_v68/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v68/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_editChatPhoto.md b/old_docs/API_docs_v68/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v68/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_editChatTitle.md b/old_docs/API_docs_v68/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v68/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v68/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v68/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_editMessage.md b/old_docs/API_docs_v68/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v68/methods/messages_editMessage.md +++ b/old_docs/API_docs_v68/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_exportChatInvite.md b/old_docs/API_docs_v68/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v68/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v68/methods/messages_forwardMessage.md b/old_docs/API_docs_v68/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v68/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v68/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_forwardMessages.md b/old_docs/API_docs_v68/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v68/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v68/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAllChats.md b/old_docs/API_docs_v68/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v68/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAllStickers.md b/old_docs/API_docs_v68/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v68/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v68/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v68/methods/messages_getChats.md b/old_docs/API_docs_v68/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v68/methods/messages_getChats.md +++ b/old_docs/API_docs_v68/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/messages_getCommonChats.md b/old_docs/API_docs_v68/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v68/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v68/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v68/methods/messages_getDialogs.md b/old_docs/API_docs_v68/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v68/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v68/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getGameHighScores.md b/old_docs/API_docs_v68/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v68/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v68/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v68/methods/messages_getHistory.md b/old_docs/API_docs_v68/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v68/methods/messages_getHistory.md +++ b/old_docs/API_docs_v68/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v68/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v68/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMaskStickers.md b/old_docs/API_docs_v68/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v68/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessageEditData.md b/old_docs/API_docs_v68/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v68/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessages.md b/old_docs/API_docs_v68/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessages.md +++ b/old_docs/API_docs_v68/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/messages_getMessagesViews.md b/old_docs/API_docs_v68/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v68/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v68/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getPeerSettings.md b/old_docs/API_docs_v68/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v68/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v68/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v68/methods/messages_getRecentStickers.md b/old_docs/API_docs_v68/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v68/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v68/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v68/methods/messages_getSavedGifs.md b/old_docs/API_docs_v68/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v68/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v68/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v68/methods/messages_getStickerSet.md b/old_docs/API_docs_v68/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v68/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v68/methods/messages_getWebPage.md b/old_docs/API_docs_v68/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v68/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v68/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v68/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v68/methods/messages_hideReportSpam.md b/old_docs/API_docs_v68/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v68/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v68/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_importChatInvite.md b/old_docs/API_docs_v68/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v68/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v68/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_installStickerSet.md b/old_docs/API_docs_v68/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v68/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v68/methods/messages_migrateChat.md b/old_docs/API_docs_v68/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v68/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v68/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v68/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v68/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_readHistory.md b/old_docs/API_docs_v68/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v68/methods/messages_readHistory.md +++ b/old_docs/API_docs_v68/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v68/methods/messages_readMessageContents.md b/old_docs/API_docs_v68/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v68/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v68/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v68/methods/messages_receivedMessages.md b/old_docs/API_docs_v68/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v68/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v68/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v68/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v68/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v68/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_reportSpam.md b/old_docs/API_docs_v68/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v68/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v68/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_saveDraft.md b/old_docs/API_docs_v68/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v68/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v68/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_saveGif.md b/old_docs/API_docs_v68/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v68/methods/messages_saveGif.md +++ b/old_docs/API_docs_v68/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v68/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_search.md b/old_docs/API_docs_v68/methods/messages_search.md index b85f639a..a6feab33 100644 --- a/old_docs/API_docs_v68/methods/messages_search.md +++ b/old_docs/API_docs_v68/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/messages_searchGifs.md b/old_docs/API_docs_v68/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v68/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v68/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v68/methods/messages_searchGlobal.md b/old_docs/API_docs_v68/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v68/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v68/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendEncrypted.md b/old_docs/API_docs_v68/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v68/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v68/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_sendMedia.md b/old_docs/API_docs_v68/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v68/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v68/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v68/methods/messages_sendMessage.md b/old_docs/API_docs_v68/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v68/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v68/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v68/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v68/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v68/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v68/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setGameScore.md b/old_docs/API_docs_v68/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v68/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v68/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v68/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v68/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_setTyping.md b/old_docs/API_docs_v68/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v68/methods/messages_setTyping.md +++ b/old_docs/API_docs_v68/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_startBot.md b/old_docs/API_docs_v68/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v68/methods/messages_startBot.md +++ b/old_docs/API_docs_v68/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v68/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v68/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v68/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/messages_uploadMedia.md b/old_docs/API_docs_v68/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v68/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v68/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/payments_getPaymentForm.md b/old_docs/API_docs_v68/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v68/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v68/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v68/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v68/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v68/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v68/methods/phone_receivedCall.md b/old_docs/API_docs_v68/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v68/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v68/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/phone_saveCallDebug.md b/old_docs/API_docs_v68/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v68/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v68/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/phone_setCallRating.md b/old_docs/API_docs_v68/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v68/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v68/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v68/methods/photos_deletePhotos.md b/old_docs/API_docs_v68/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v68/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v68/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v68/methods/photos_getUserPhotos.md b/old_docs/API_docs_v68/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v68/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v68/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v68/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v68/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v68/methods/ping.md b/old_docs/API_docs_v68/methods/ping.md index dadae42f..d07839e4 100644 --- a/old_docs/API_docs_v68/methods/ping.md +++ b/old_docs/API_docs_v68/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v68/methods/ping_delay_disconnect.md b/old_docs/API_docs_v68/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/old_docs/API_docs_v68/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v68/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v68/methods/req_DH_params.md b/old_docs/API_docs_v68/methods/req_DH_params.md index 89140510..54dd35a0 100644 --- a/old_docs/API_docs_v68/methods/req_DH_params.md +++ b/old_docs/API_docs_v68/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[string](../types/string.md) | Yes|factorized p from pq| -|q|[string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[string](../types/string.md) | factorized p from pq | Yes| +|q|[string](../types/string.md) | factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v68/methods/req_pq.md b/old_docs/API_docs_v68/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/old_docs/API_docs_v68/methods/req_pq.md +++ b/old_docs/API_docs_v68/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v68/methods/rpc_drop_answer.md b/old_docs/API_docs_v68/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/old_docs/API_docs_v68/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v68/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v68/methods/set_client_DH_params.md b/old_docs/API_docs_v68/methods/set_client_DH_params.md index 79a43a88..41bbb00f 100644 --- a/old_docs/API_docs_v68/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v68/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v68/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md index 4c663721..589b06e2 100644 --- a/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v68/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/stickers_createStickerSet.md b/old_docs/API_docs_v68/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v68/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v68/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md index e6c6a3de..3ea1c684 100644 --- a/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v68/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v68/methods/upload_getWebFile.md b/old_docs/API_docs_v68/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v68/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v68/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v68/methods/users_getUsers.md b/old_docs/API_docs_v68/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v68/methods/users_getUsers.md +++ b/old_docs/API_docs_v68/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v70/methods/account_changePhone.md b/old_docs/API_docs_v70/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v70/methods/account_changePhone.md +++ b/old_docs/API_docs_v70/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_checkUsername.md b/old_docs/API_docs_v70/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v70/methods/account_checkUsername.md +++ b/old_docs/API_docs_v70/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_confirmPhone.md b/old_docs/API_docs_v70/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v70/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v70/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_deleteAccount.md b/old_docs/API_docs_v70/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v70/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v70/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_getNotifySettings.md b/old_docs/API_docs_v70/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v70/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v70/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_getPasswordSettings.md b/old_docs/API_docs_v70/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v70/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v70/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_getPrivacy.md b/old_docs/API_docs_v70/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v70/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v70/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_getTmpPassword.md b/old_docs/API_docs_v70/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v70/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v70/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_registerDevice.md b/old_docs/API_docs_v70/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v70/methods/account_registerDevice.md +++ b/old_docs/API_docs_v70/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/account_reportPeer.md b/old_docs/API_docs_v70/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v70/methods/account_reportPeer.md +++ b/old_docs/API_docs_v70/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_resetAuthorization.md b/old_docs/API_docs_v70/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v70/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v70/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v70/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v70/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_setAccountTTL.md b/old_docs/API_docs_v70/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v70/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v70/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_setPrivacy.md b/old_docs/API_docs_v70/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v70/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v70/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_unregisterDevice.md b/old_docs/API_docs_v70/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v70/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v70/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v70/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_updateNotifySettings.md b/old_docs/API_docs_v70/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v70/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v70/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v70/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_updateProfile.md b/old_docs/API_docs_v70/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v70/methods/account_updateProfile.md +++ b/old_docs/API_docs_v70/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_updateStatus.md b/old_docs/API_docs_v70/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v70/methods/account_updateStatus.md +++ b/old_docs/API_docs_v70/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/account_updateUsername.md b/old_docs/API_docs_v70/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v70/methods/account_updateUsername.md +++ b/old_docs/API_docs_v70/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/auth_cancelCode.md b/old_docs/API_docs_v70/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v70/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v70/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/auth_checkPhone.md b/old_docs/API_docs_v70/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v70/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v70/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v70/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/auth_recoverPassword.md b/old_docs/API_docs_v70/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v70/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v70/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/auth_resendCode.md b/old_docs/API_docs_v70/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v70/methods/auth_resendCode.md +++ b/old_docs/API_docs_v70/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/auth_sendInvites.md b/old_docs/API_docs_v70/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v70/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v70/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v70/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v70/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_checkUsername.md b/old_docs/API_docs_v70/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v70/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v70/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_createChannel.md b/old_docs/API_docs_v70/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v70/methods/channels_createChannel.md +++ b/old_docs/API_docs_v70/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_deleteChannel.md b/old_docs/API_docs_v70/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v70/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_deleteMessages.md b/old_docs/API_docs_v70/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v70/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v70/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_editAbout.md b/old_docs/API_docs_v70/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v70/methods/channels_editAbout.md +++ b/old_docs/API_docs_v70/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_editAdmin.md b/old_docs/API_docs_v70/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v70/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v70/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_editBanned.md b/old_docs/API_docs_v70/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v70/methods/channels_editBanned.md +++ b/old_docs/API_docs_v70/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_editPhoto.md b/old_docs/API_docs_v70/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v70/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v70/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_editTitle.md b/old_docs/API_docs_v70/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v70/methods/channels_editTitle.md +++ b/old_docs/API_docs_v70/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_exportInvite.md b/old_docs/API_docs_v70/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v70/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v70/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_exportMessageLink.md b/old_docs/API_docs_v70/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v70/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v70/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v70/methods/channels_getAdminLog.md b/old_docs/API_docs_v70/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v70/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v70/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_getChannels.md b/old_docs/API_docs_v70/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v70/methods/channels_getChannels.md +++ b/old_docs/API_docs_v70/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_getMessages.md b/old_docs/API_docs_v70/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v70/methods/channels_getMessages.md +++ b/old_docs/API_docs_v70/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/channels_getParticipant.md b/old_docs/API_docs_v70/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v70/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v70/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_getParticipants.md b/old_docs/API_docs_v70/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v70/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v70/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v70/methods/channels_inviteToChannel.md b/old_docs/API_docs_v70/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v70/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v70/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_joinChannel.md b/old_docs/API_docs_v70/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v70/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v70/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_leaveChannel.md b/old_docs/API_docs_v70/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v70/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v70/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_readHistory.md b/old_docs/API_docs_v70/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v70/methods/channels_readHistory.md +++ b/old_docs/API_docs_v70/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_reportSpam.md b/old_docs/API_docs_v70/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v70/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v70/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_toggleInvites.md b/old_docs/API_docs_v70/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v70/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v70/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_toggleSignatures.md b/old_docs/API_docs_v70/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v70/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v70/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/channels_updateUsername.md b/old_docs/API_docs_v70/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v70/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v70/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_block.md b/old_docs/API_docs_v70/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v70/methods/contacts_block.md +++ b/old_docs/API_docs_v70/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_deleteContact.md b/old_docs/API_docs_v70/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v70/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v70/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_deleteContacts.md b/old_docs/API_docs_v70/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v70/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v70/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_getBlocked.md b/old_docs/API_docs_v70/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v70/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v70/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_getContacts.md b/old_docs/API_docs_v70/methods/contacts_getContacts.md index 41361208..42502717 100644 --- a/old_docs/API_docs_v70/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v70/methods/contacts_getContacts.md @@ -11,9 +11,9 @@ Get all contacts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|$MadelineProto->gen_vector_hash(previously fetched user IDs);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | $MadelineProto->gen_vector_hash(previously fetched user IDs); | Yes| ### Return type: [contacts\_Contacts](../types/contacts_Contacts.md) diff --git a/old_docs/API_docs_v70/methods/contacts_getTopPeers.md b/old_docs/API_docs_v70/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v70/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v70/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_importCard.md b/old_docs/API_docs_v70/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v70/methods/contacts_importCard.md +++ b/old_docs/API_docs_v70/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_importContacts.md b/old_docs/API_docs_v70/methods/contacts_importContacts.md index c1b8a62a..d0404dd2 100644 --- a/old_docs/API_docs_v70/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v70/methods/contacts_importContacts.md @@ -11,10 +11,10 @@ Add phone number as contact ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|contacts|Array of [InputContact](../types/InputContact.md) | Yes|The numbers to import| -|replace|[Bool](../types/Bool.md) | Yes|Replace contacts?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|contacts|Array of [InputContact](../types/InputContact.md) | The numbers to import | Yes| +|replace|[Bool](../types/Bool.md) | Replace contacts? | Yes| ### Return type: [contacts\_ImportedContacts](../types/contacts_ImportedContacts.md) diff --git a/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v70/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_search.md b/old_docs/API_docs_v70/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v70/methods/contacts_search.md +++ b/old_docs/API_docs_v70/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contacts_unblock.md b/old_docs/API_docs_v70/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v70/methods/contacts_unblock.md +++ b/old_docs/API_docs_v70/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md index 4b391435..5761cdc8 100644 --- a/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v70/methods/contest_saveDeveloperInfo.md @@ -11,13 +11,13 @@ Save developer info for telegram contest ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|vk\_id|[int](../types/int.md) | Yes|VK user ID| -|name|[string](../types/string.md) | Yes|Name| -|phone\_number|[string](../types/string.md) | Yes|Phone number| -|age|[int](../types/int.md) | Yes|Age| -|city|[string](../types/string.md) | Yes|City| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|vk\_id|[int](../types/int.md) | VK user ID | Yes| +|name|[string](../types/string.md) | Name | Yes| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|age|[int](../types/int.md) | Age | Yes| +|city|[string](../types/string.md) | City | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/destroy_session.md b/old_docs/API_docs_v70/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/old_docs/API_docs_v70/methods/destroy_session.md +++ b/old_docs/API_docs_v70/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v70/methods/get_future_salts.md b/old_docs/API_docs_v70/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/old_docs/API_docs_v70/methods/get_future_salts.md +++ b/old_docs/API_docs_v70/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v70/methods/help_getAppChangelog.md b/old_docs/API_docs_v70/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v70/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v70/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/help_saveAppLog.md b/old_docs/API_docs_v70/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v70/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v70/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v70/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/initConnection.md b/old_docs/API_docs_v70/methods/initConnection.md index de4c0c00..692a41e8 100644 --- a/old_docs/API_docs_v70/methods/initConnection.md +++ b/old_docs/API_docs_v70/methods/initConnection.md @@ -11,16 +11,16 @@ 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| -|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| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v70/methods/invokeAfterMsg.md b/old_docs/API_docs_v70/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v70/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v70/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/invokeAfterMsgs.md b/old_docs/API_docs_v70/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v70/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v70/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/invokeWithLayer.md b/old_docs/API_docs_v70/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v70/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v70/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v70/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/langpack_getDifference.md b/old_docs/API_docs_v70/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v70/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v70/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/langpack_getLangPack.md b/old_docs/API_docs_v70/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v70/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v70/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/langpack_getStrings.md b/old_docs/API_docs_v70/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v70/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v70/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/messages_addChatUser.md b/old_docs/API_docs_v70/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v70/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v70/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v70/methods/messages_checkChatInvite.md b/old_docs/API_docs_v70/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v70/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v70/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_createChat.md b/old_docs/API_docs_v70/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v70/methods/messages_createChat.md +++ b/old_docs/API_docs_v70/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_deleteChatUser.md b/old_docs/API_docs_v70/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v70/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_deleteHistory.md b/old_docs/API_docs_v70/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v70/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v70/methods/messages_deleteMessages.md b/old_docs/API_docs_v70/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v70/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v70/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v70/methods/messages_editChatAdmin.md b/old_docs/API_docs_v70/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v70/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_editChatPhoto.md b/old_docs/API_docs_v70/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v70/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_editChatTitle.md b/old_docs/API_docs_v70/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v70/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v70/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v70/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_editMessage.md b/old_docs/API_docs_v70/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v70/methods/messages_editMessage.md +++ b/old_docs/API_docs_v70/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_exportChatInvite.md b/old_docs/API_docs_v70/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v70/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v70/methods/messages_forwardMessage.md b/old_docs/API_docs_v70/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v70/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v70/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_forwardMessages.md b/old_docs/API_docs_v70/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v70/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v70/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAllChats.md b/old_docs/API_docs_v70/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v70/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAllStickers.md b/old_docs/API_docs_v70/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v70/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v70/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v70/methods/messages_getChats.md b/old_docs/API_docs_v70/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v70/methods/messages_getChats.md +++ b/old_docs/API_docs_v70/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/messages_getCommonChats.md b/old_docs/API_docs_v70/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v70/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v70/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v70/methods/messages_getDialogs.md b/old_docs/API_docs_v70/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v70/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v70/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getGameHighScores.md b/old_docs/API_docs_v70/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v70/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v70/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v70/methods/messages_getHistory.md b/old_docs/API_docs_v70/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v70/methods/messages_getHistory.md +++ b/old_docs/API_docs_v70/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v70/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v70/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMaskStickers.md b/old_docs/API_docs_v70/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v70/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessageEditData.md b/old_docs/API_docs_v70/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v70/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessages.md b/old_docs/API_docs_v70/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessages.md +++ b/old_docs/API_docs_v70/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/messages_getMessagesViews.md b/old_docs/API_docs_v70/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v70/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v70/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getPeerSettings.md b/old_docs/API_docs_v70/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v70/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v70/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v70/methods/messages_getRecentStickers.md b/old_docs/API_docs_v70/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v70/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v70/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v70/methods/messages_getSavedGifs.md b/old_docs/API_docs_v70/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v70/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v70/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v70/methods/messages_getStickerSet.md b/old_docs/API_docs_v70/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v70/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/messages_getWebPage.md b/old_docs/API_docs_v70/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v70/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v70/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v70/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v70/methods/messages_hideReportSpam.md b/old_docs/API_docs_v70/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v70/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v70/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_importChatInvite.md b/old_docs/API_docs_v70/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v70/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v70/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_installStickerSet.md b/old_docs/API_docs_v70/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v70/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v70/methods/messages_migrateChat.md b/old_docs/API_docs_v70/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v70/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v70/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v70/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v70/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_readHistory.md b/old_docs/API_docs_v70/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v70/methods/messages_readHistory.md +++ b/old_docs/API_docs_v70/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v70/methods/messages_readMessageContents.md b/old_docs/API_docs_v70/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v70/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v70/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v70/methods/messages_receivedMessages.md b/old_docs/API_docs_v70/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v70/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v70/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v70/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v70/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v70/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_reportSpam.md b/old_docs/API_docs_v70/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v70/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v70/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_saveDraft.md b/old_docs/API_docs_v70/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v70/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v70/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_saveGif.md b/old_docs/API_docs_v70/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v70/methods/messages_saveGif.md +++ b/old_docs/API_docs_v70/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v70/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_search.md b/old_docs/API_docs_v70/methods/messages_search.md index b85f639a..a6feab33 100644 --- a/old_docs/API_docs_v70/methods/messages_search.md +++ b/old_docs/API_docs_v70/methods/messages_search.md @@ -11,17 +11,17 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset|[int](../types/int.md) | Yes|Offset | -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/messages_searchGifs.md b/old_docs/API_docs_v70/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v70/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v70/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v70/methods/messages_searchGlobal.md b/old_docs/API_docs_v70/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v70/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v70/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendEncrypted.md b/old_docs/API_docs_v70/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v70/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v70/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_sendMedia.md b/old_docs/API_docs_v70/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v70/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v70/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v70/methods/messages_sendMessage.md b/old_docs/API_docs_v70/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v70/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v70/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v70/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v70/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v70/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v70/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v70/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setGameScore.md b/old_docs/API_docs_v70/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v70/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v70/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v70/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v70/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_setTyping.md b/old_docs/API_docs_v70/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v70/methods/messages_setTyping.md +++ b/old_docs/API_docs_v70/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_startBot.md b/old_docs/API_docs_v70/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v70/methods/messages_startBot.md +++ b/old_docs/API_docs_v70/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v70/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v70/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v70/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/messages_uploadMedia.md b/old_docs/API_docs_v70/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v70/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v70/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/payments_getPaymentForm.md b/old_docs/API_docs_v70/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v70/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v70/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v70/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v70/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v70/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v70/methods/phone_receivedCall.md b/old_docs/API_docs_v70/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v70/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v70/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/phone_saveCallDebug.md b/old_docs/API_docs_v70/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v70/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v70/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v70/methods/phone_setCallRating.md b/old_docs/API_docs_v70/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v70/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v70/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v70/methods/photos_deletePhotos.md b/old_docs/API_docs_v70/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v70/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v70/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v70/methods/photos_getUserPhotos.md b/old_docs/API_docs_v70/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v70/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v70/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v70/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v70/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v70/methods/ping.md b/old_docs/API_docs_v70/methods/ping.md index dadae42f..d07839e4 100644 --- a/old_docs/API_docs_v70/methods/ping.md +++ b/old_docs/API_docs_v70/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v70/methods/ping_delay_disconnect.md b/old_docs/API_docs_v70/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/old_docs/API_docs_v70/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v70/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v70/methods/req_DH_params.md b/old_docs/API_docs_v70/methods/req_DH_params.md index 89140510..54dd35a0 100644 --- a/old_docs/API_docs_v70/methods/req_DH_params.md +++ b/old_docs/API_docs_v70/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[string](../types/string.md) | Yes|factorized p from pq| -|q|[string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[string](../types/string.md) | factorized p from pq | Yes| +|q|[string](../types/string.md) | factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v70/methods/req_pq.md b/old_docs/API_docs_v70/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/old_docs/API_docs_v70/methods/req_pq.md +++ b/old_docs/API_docs_v70/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v70/methods/rpc_drop_answer.md b/old_docs/API_docs_v70/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/old_docs/API_docs_v70/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v70/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v70/methods/set_client_DH_params.md b/old_docs/API_docs_v70/methods/set_client_DH_params.md index 79a43a88..41bbb00f 100644 --- a/old_docs/API_docs_v70/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v70/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v70/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v70/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/stickers_createStickerSet.md b/old_docs/API_docs_v70/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v70/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v70/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v70/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v70/methods/upload_getWebFile.md b/old_docs/API_docs_v70/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v70/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v70/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v70/methods/users_getUsers.md b/old_docs/API_docs_v70/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v70/methods/users_getUsers.md +++ b/old_docs/API_docs_v70/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v71/methods/account_changePhone.md b/old_docs/API_docs_v71/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v71/methods/account_changePhone.md +++ b/old_docs/API_docs_v71/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_checkUsername.md b/old_docs/API_docs_v71/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v71/methods/account_checkUsername.md +++ b/old_docs/API_docs_v71/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_confirmPhone.md b/old_docs/API_docs_v71/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v71/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v71/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_deleteAccount.md b/old_docs/API_docs_v71/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v71/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v71/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_getNotifySettings.md b/old_docs/API_docs_v71/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v71/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v71/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_getPasswordSettings.md b/old_docs/API_docs_v71/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v71/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v71/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_getPrivacy.md b/old_docs/API_docs_v71/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v71/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v71/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_getTmpPassword.md b/old_docs/API_docs_v71/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v71/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v71/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_registerDevice.md b/old_docs/API_docs_v71/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v71/methods/account_registerDevice.md +++ b/old_docs/API_docs_v71/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/account_reportPeer.md b/old_docs/API_docs_v71/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v71/methods/account_reportPeer.md +++ b/old_docs/API_docs_v71/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_resetAuthorization.md b/old_docs/API_docs_v71/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v71/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v71/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v71/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v71/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_setAccountTTL.md b/old_docs/API_docs_v71/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v71/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v71/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_setPrivacy.md b/old_docs/API_docs_v71/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v71/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v71/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_unregisterDevice.md b/old_docs/API_docs_v71/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v71/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v71/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v71/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_updateNotifySettings.md b/old_docs/API_docs_v71/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v71/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v71/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v71/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_updateProfile.md b/old_docs/API_docs_v71/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v71/methods/account_updateProfile.md +++ b/old_docs/API_docs_v71/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_updateStatus.md b/old_docs/API_docs_v71/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v71/methods/account_updateStatus.md +++ b/old_docs/API_docs_v71/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/account_updateUsername.md b/old_docs/API_docs_v71/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v71/methods/account_updateUsername.md +++ b/old_docs/API_docs_v71/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/auth_cancelCode.md b/old_docs/API_docs_v71/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v71/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v71/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/auth_checkPhone.md b/old_docs/API_docs_v71/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v71/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v71/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v71/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/auth_recoverPassword.md b/old_docs/API_docs_v71/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v71/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v71/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/auth_resendCode.md b/old_docs/API_docs_v71/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v71/methods/auth_resendCode.md +++ b/old_docs/API_docs_v71/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/auth_sendInvites.md b/old_docs/API_docs_v71/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v71/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v71/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v71/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v71/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_checkUsername.md b/old_docs/API_docs_v71/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v71/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v71/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_createChannel.md b/old_docs/API_docs_v71/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v71/methods/channels_createChannel.md +++ b/old_docs/API_docs_v71/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_deleteChannel.md b/old_docs/API_docs_v71/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v71/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_deleteMessages.md b/old_docs/API_docs_v71/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v71/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v71/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_editAbout.md b/old_docs/API_docs_v71/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v71/methods/channels_editAbout.md +++ b/old_docs/API_docs_v71/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_editAdmin.md b/old_docs/API_docs_v71/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v71/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v71/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_editBanned.md b/old_docs/API_docs_v71/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v71/methods/channels_editBanned.md +++ b/old_docs/API_docs_v71/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_editPhoto.md b/old_docs/API_docs_v71/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v71/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v71/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_editTitle.md b/old_docs/API_docs_v71/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v71/methods/channels_editTitle.md +++ b/old_docs/API_docs_v71/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_exportInvite.md b/old_docs/API_docs_v71/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v71/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v71/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_exportMessageLink.md b/old_docs/API_docs_v71/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v71/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v71/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v71/methods/channels_getAdminLog.md b/old_docs/API_docs_v71/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v71/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v71/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_getChannels.md b/old_docs/API_docs_v71/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v71/methods/channels_getChannels.md +++ b/old_docs/API_docs_v71/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_getMessages.md b/old_docs/API_docs_v71/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v71/methods/channels_getMessages.md +++ b/old_docs/API_docs_v71/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/channels_getParticipant.md b/old_docs/API_docs_v71/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v71/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v71/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_getParticipants.md b/old_docs/API_docs_v71/methods/channels_getParticipants.md index 5ced296d..c2f0cdcd 100644 --- a/old_docs/API_docs_v71/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v71/methods/channels_getParticipants.md @@ -11,12 +11,12 @@ 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| +| 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| ### Return type: [channels\_ChannelParticipants](../types/channels_ChannelParticipants.md) diff --git a/old_docs/API_docs_v71/methods/channels_inviteToChannel.md b/old_docs/API_docs_v71/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v71/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v71/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_joinChannel.md b/old_docs/API_docs_v71/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v71/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v71/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_leaveChannel.md b/old_docs/API_docs_v71/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v71/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v71/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_readHistory.md b/old_docs/API_docs_v71/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v71/methods/channels_readHistory.md +++ b/old_docs/API_docs_v71/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_readMessageContents.md b/old_docs/API_docs_v71/methods/channels_readMessageContents.md index f0addc30..51fffda5 100644 --- a/old_docs/API_docs_v71/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v71/methods/channels_readMessageContents.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_reportSpam.md b/old_docs/API_docs_v71/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v71/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v71/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_setStickers.md b/old_docs/API_docs_v71/methods/channels_setStickers.md index 8557a723..421b3ec1 100644 --- a/old_docs/API_docs_v71/methods/channels_setStickers.md +++ b/old_docs/API_docs_v71/methods/channels_setStickers.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_toggleInvites.md b/old_docs/API_docs_v71/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v71/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v71/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_toggleSignatures.md b/old_docs/API_docs_v71/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v71/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v71/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v71/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/channels_updateUsername.md b/old_docs/API_docs_v71/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v71/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v71/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_block.md b/old_docs/API_docs_v71/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v71/methods/contacts_block.md +++ b/old_docs/API_docs_v71/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_deleteContact.md b/old_docs/API_docs_v71/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v71/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v71/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_deleteContacts.md b/old_docs/API_docs_v71/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v71/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v71/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_getBlocked.md b/old_docs/API_docs_v71/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v71/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v71/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_getContacts.md b/old_docs/API_docs_v71/methods/contacts_getContacts.md index 58c49847..48634fbb 100644 --- a/old_docs/API_docs_v71/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v71/methods/contacts_getContacts.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_getTopPeers.md b/old_docs/API_docs_v71/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v71/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v71/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_importCard.md b/old_docs/API_docs_v71/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v71/methods/contacts_importCard.md +++ b/old_docs/API_docs_v71/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_importContacts.md b/old_docs/API_docs_v71/methods/contacts_importContacts.md index 6aee0ac0..eddbe116 100644 --- a/old_docs/API_docs_v71/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v71/methods/contacts_importContacts.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v71/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_search.md b/old_docs/API_docs_v71/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v71/methods/contacts_search.md +++ b/old_docs/API_docs_v71/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contacts_unblock.md b/old_docs/API_docs_v71/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v71/methods/contacts_unblock.md +++ b/old_docs/API_docs_v71/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md index 4b391435..5761cdc8 100644 --- a/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v71/methods/contest_saveDeveloperInfo.md @@ -11,13 +11,13 @@ Save developer info for telegram contest ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|vk\_id|[int](../types/int.md) | Yes|VK user ID| -|name|[string](../types/string.md) | Yes|Name| -|phone\_number|[string](../types/string.md) | Yes|Phone number| -|age|[int](../types/int.md) | Yes|Age| -|city|[string](../types/string.md) | Yes|City| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|vk\_id|[int](../types/int.md) | VK user ID | Yes| +|name|[string](../types/string.md) | Name | Yes| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|age|[int](../types/int.md) | Age | Yes| +|city|[string](../types/string.md) | City | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/destroy_session.md b/old_docs/API_docs_v71/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/old_docs/API_docs_v71/methods/destroy_session.md +++ b/old_docs/API_docs_v71/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v71/methods/get_future_salts.md b/old_docs/API_docs_v71/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/old_docs/API_docs_v71/methods/get_future_salts.md +++ b/old_docs/API_docs_v71/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v71/methods/help_getAppChangelog.md b/old_docs/API_docs_v71/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v71/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v71/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/help_saveAppLog.md b/old_docs/API_docs_v71/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v71/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v71/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v71/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/initConnection.md b/old_docs/API_docs_v71/methods/initConnection.md index de4c0c00..692a41e8 100644 --- a/old_docs/API_docs_v71/methods/initConnection.md +++ b/old_docs/API_docs_v71/methods/initConnection.md @@ -11,16 +11,16 @@ 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| -|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| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v71/methods/invokeAfterMsg.md b/old_docs/API_docs_v71/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v71/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v71/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/invokeAfterMsgs.md b/old_docs/API_docs_v71/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v71/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v71/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/invokeWithLayer.md b/old_docs/API_docs_v71/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v71/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v71/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v71/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/langpack_getDifference.md b/old_docs/API_docs_v71/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v71/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v71/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/langpack_getLangPack.md b/old_docs/API_docs_v71/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v71/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v71/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/langpack_getStrings.md b/old_docs/API_docs_v71/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v71/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v71/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/messages_addChatUser.md b/old_docs/API_docs_v71/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v71/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v71/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v71/methods/messages_checkChatInvite.md b/old_docs/API_docs_v71/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v71/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v71/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_createChat.md b/old_docs/API_docs_v71/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v71/methods/messages_createChat.md +++ b/old_docs/API_docs_v71/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_deleteChatUser.md b/old_docs/API_docs_v71/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v71/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_deleteHistory.md b/old_docs/API_docs_v71/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v71/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v71/methods/messages_deleteMessages.md b/old_docs/API_docs_v71/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v71/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v71/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v71/methods/messages_editChatAdmin.md b/old_docs/API_docs_v71/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v71/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_editChatPhoto.md b/old_docs/API_docs_v71/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v71/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_editChatTitle.md b/old_docs/API_docs_v71/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v71/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v71/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v71/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_editMessage.md b/old_docs/API_docs_v71/methods/messages_editMessage.md index 8c1c1727..daef53a5 100644 --- a/old_docs/API_docs_v71/methods/messages_editMessage.md +++ b/old_docs/API_docs_v71/methods/messages_editMessage.md @@ -11,14 +11,14 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_exportChatInvite.md b/old_docs/API_docs_v71/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v71/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v71/methods/messages_faveSticker.md b/old_docs/API_docs_v71/methods/messages_faveSticker.md index 05c04983..302957c5 100644 --- a/old_docs/API_docs_v71/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v71/methods/messages_faveSticker.md @@ -11,10 +11,10 @@ Add a sticker to favorites ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional| +|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_forwardMessage.md b/old_docs/API_docs_v71/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v71/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v71/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_forwardMessages.md b/old_docs/API_docs_v71/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v71/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v71/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAllChats.md b/old_docs/API_docs_v71/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v71/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAllStickers.md b/old_docs/API_docs_v71/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v71/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v71/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v71/methods/messages_getChats.md b/old_docs/API_docs_v71/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v71/methods/messages_getChats.md +++ b/old_docs/API_docs_v71/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/messages_getCommonChats.md b/old_docs/API_docs_v71/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v71/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v71/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v71/methods/messages_getDialogs.md b/old_docs/API_docs_v71/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v71/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v71/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v71/methods/messages_getFavedStickers.md b/old_docs/API_docs_v71/methods/messages_getFavedStickers.md index cae141f4..4ea69f9f 100644 --- a/old_docs/API_docs_v71/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getFavedStickers.md @@ -11,9 +11,9 @@ Get favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getGameHighScores.md b/old_docs/API_docs_v71/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v71/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v71/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v71/methods/messages_getHistory.md b/old_docs/API_docs_v71/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v71/methods/messages_getHistory.md +++ b/old_docs/API_docs_v71/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v71/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v71/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMaskStickers.md b/old_docs/API_docs_v71/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v71/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessageEditData.md b/old_docs/API_docs_v71/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v71/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessages.md b/old_docs/API_docs_v71/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessages.md +++ b/old_docs/API_docs_v71/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_getMessagesViews.md b/old_docs/API_docs_v71/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v71/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v71/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getPeerSettings.md b/old_docs/API_docs_v71/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v71/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v71/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v71/methods/messages_getRecentStickers.md b/old_docs/API_docs_v71/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v71/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v71/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v71/methods/messages_getSavedGifs.md b/old_docs/API_docs_v71/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v71/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v71/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v71/methods/messages_getStickerSet.md b/old_docs/API_docs_v71/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v71/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md index 88e895e4..9b221db9 100644 --- a/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v71/methods/messages_getUnreadMentions.md @@ -11,14 +11,14 @@ Get unread mentions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[int](../types/int.md) | Yes|The offset| -|add\_offset|[int](../types/int.md) | Yes|The additional offset| -|limit|[int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to get unread mentions | Optional| +|offset\_id|[int](../types/int.md) | The offset | Yes| +|add\_offset|[int](../types/int.md) | The additional offset | Yes| +|limit|[int](../types/int.md) | The number of results to fetch | Yes| +|max\_id|[int](../types/int.md) | The maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | The minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_getWebPage.md b/old_docs/API_docs_v71/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v71/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v71/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v71/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v71/methods/messages_hideReportSpam.md b/old_docs/API_docs_v71/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v71/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v71/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_importChatInvite.md b/old_docs/API_docs_v71/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v71/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v71/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_installStickerSet.md b/old_docs/API_docs_v71/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v71/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v71/methods/messages_migrateChat.md b/old_docs/API_docs_v71/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v71/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v71/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v71/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v71/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_readHistory.md b/old_docs/API_docs_v71/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v71/methods/messages_readHistory.md +++ b/old_docs/API_docs_v71/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v71/methods/messages_readMessageContents.md b/old_docs/API_docs_v71/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v71/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v71/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v71/methods/messages_receivedMessages.md b/old_docs/API_docs_v71/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v71/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v71/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v71/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v71/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v71/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_reportSpam.md b/old_docs/API_docs_v71/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v71/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v71/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_saveDraft.md b/old_docs/API_docs_v71/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v71/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v71/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_saveGif.md b/old_docs/API_docs_v71/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v71/methods/messages_saveGif.md +++ b/old_docs/API_docs_v71/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v71/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_search.md b/old_docs/API_docs_v71/methods/messages_search.md index a0907b88..159f893b 100644 --- a/old_docs/API_docs_v71/methods/messages_search.md +++ b/old_docs/API_docs_v71/methods/messages_search.md @@ -11,19 +11,19 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|min\_id|[int](../types/int.md) | Minumum message id to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_searchGifs.md b/old_docs/API_docs_v71/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v71/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v71/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v71/methods/messages_searchGlobal.md b/old_docs/API_docs_v71/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v71/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v71/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendEncrypted.md b/old_docs/API_docs_v71/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v71/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v71/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_sendMedia.md b/old_docs/API_docs_v71/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v71/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v71/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v71/methods/messages_sendMessage.md b/old_docs/API_docs_v71/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v71/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v71/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v71/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v71/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v71/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v71/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v71/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setGameScore.md b/old_docs/API_docs_v71/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v71/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v71/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v71/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v71/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_setTyping.md b/old_docs/API_docs_v71/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v71/methods/messages_setTyping.md +++ b/old_docs/API_docs_v71/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_startBot.md b/old_docs/API_docs_v71/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v71/methods/messages_startBot.md +++ b/old_docs/API_docs_v71/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v71/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v71/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v71/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/messages_uploadMedia.md b/old_docs/API_docs_v71/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v71/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v71/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/payments_getPaymentForm.md b/old_docs/API_docs_v71/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v71/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v71/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v71/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v71/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v71/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v71/methods/phone_receivedCall.md b/old_docs/API_docs_v71/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v71/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v71/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/phone_saveCallDebug.md b/old_docs/API_docs_v71/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v71/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v71/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v71/methods/phone_setCallRating.md b/old_docs/API_docs_v71/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v71/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v71/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v71/methods/photos_deletePhotos.md b/old_docs/API_docs_v71/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v71/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v71/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v71/methods/photos_getUserPhotos.md b/old_docs/API_docs_v71/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v71/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v71/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v71/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v71/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v71/methods/ping.md b/old_docs/API_docs_v71/methods/ping.md index dadae42f..d07839e4 100644 --- a/old_docs/API_docs_v71/methods/ping.md +++ b/old_docs/API_docs_v71/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v71/methods/ping_delay_disconnect.md b/old_docs/API_docs_v71/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/old_docs/API_docs_v71/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v71/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v71/methods/req_DH_params.md b/old_docs/API_docs_v71/methods/req_DH_params.md index 89140510..54dd35a0 100644 --- a/old_docs/API_docs_v71/methods/req_DH_params.md +++ b/old_docs/API_docs_v71/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[string](../types/string.md) | Yes|factorized p from pq| -|q|[string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[string](../types/string.md) | factorized p from pq | Yes| +|q|[string](../types/string.md) | factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v71/methods/req_pq.md b/old_docs/API_docs_v71/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/old_docs/API_docs_v71/methods/req_pq.md +++ b/old_docs/API_docs_v71/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v71/methods/rpc_drop_answer.md b/old_docs/API_docs_v71/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/old_docs/API_docs_v71/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v71/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v71/methods/set_client_DH_params.md b/old_docs/API_docs_v71/methods/set_client_DH_params.md index 79a43a88..41bbb00f 100644 --- a/old_docs/API_docs_v71/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v71/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v71/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v71/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/stickers_createStickerSet.md b/old_docs/API_docs_v71/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v71/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v71/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v71/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v71/methods/upload_getWebFile.md b/old_docs/API_docs_v71/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v71/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v71/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v71/methods/users_getUsers.md b/old_docs/API_docs_v71/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v71/methods/users_getUsers.md +++ b/old_docs/API_docs_v71/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v72/methods/account_changePhone.md b/old_docs/API_docs_v72/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v72/methods/account_changePhone.md +++ b/old_docs/API_docs_v72/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_checkUsername.md b/old_docs/API_docs_v72/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v72/methods/account_checkUsername.md +++ b/old_docs/API_docs_v72/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_confirmPhone.md b/old_docs/API_docs_v72/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v72/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v72/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_deleteAccount.md b/old_docs/API_docs_v72/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v72/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v72/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_getNotifySettings.md b/old_docs/API_docs_v72/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v72/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v72/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_getPasswordSettings.md b/old_docs/API_docs_v72/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v72/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v72/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_getPrivacy.md b/old_docs/API_docs_v72/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v72/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v72/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_getTmpPassword.md b/old_docs/API_docs_v72/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v72/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v72/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_registerDevice.md b/old_docs/API_docs_v72/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v72/methods/account_registerDevice.md +++ b/old_docs/API_docs_v72/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/account_reportPeer.md b/old_docs/API_docs_v72/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v72/methods/account_reportPeer.md +++ b/old_docs/API_docs_v72/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_resetAuthorization.md b/old_docs/API_docs_v72/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v72/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v72/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v72/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v72/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_setAccountTTL.md b/old_docs/API_docs_v72/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v72/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v72/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_setPrivacy.md b/old_docs/API_docs_v72/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v72/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v72/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_unregisterDevice.md b/old_docs/API_docs_v72/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v72/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v72/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v72/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_updateNotifySettings.md b/old_docs/API_docs_v72/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v72/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v72/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v72/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_updateProfile.md b/old_docs/API_docs_v72/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v72/methods/account_updateProfile.md +++ b/old_docs/API_docs_v72/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_updateStatus.md b/old_docs/API_docs_v72/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v72/methods/account_updateStatus.md +++ b/old_docs/API_docs_v72/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/account_updateUsername.md b/old_docs/API_docs_v72/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v72/methods/account_updateUsername.md +++ b/old_docs/API_docs_v72/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/auth_cancelCode.md b/old_docs/API_docs_v72/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v72/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v72/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/auth_checkPhone.md b/old_docs/API_docs_v72/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v72/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v72/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v72/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/auth_recoverPassword.md b/old_docs/API_docs_v72/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v72/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v72/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/auth_resendCode.md b/old_docs/API_docs_v72/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v72/methods/auth_resendCode.md +++ b/old_docs/API_docs_v72/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/auth_sendInvites.md b/old_docs/API_docs_v72/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v72/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v72/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v72/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v72/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_checkUsername.md b/old_docs/API_docs_v72/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v72/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v72/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_createChannel.md b/old_docs/API_docs_v72/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v72/methods/channels_createChannel.md +++ b/old_docs/API_docs_v72/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_deleteChannel.md b/old_docs/API_docs_v72/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v72/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_deleteHistory.md b/old_docs/API_docs_v72/methods/channels_deleteHistory.md index d33bdbe0..ea331b8b 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v72/methods/channels_deleteHistory.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_deleteMessages.md b/old_docs/API_docs_v72/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v72/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v72/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_editAbout.md b/old_docs/API_docs_v72/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v72/methods/channels_editAbout.md +++ b/old_docs/API_docs_v72/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_editAdmin.md b/old_docs/API_docs_v72/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v72/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v72/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_editBanned.md b/old_docs/API_docs_v72/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v72/methods/channels_editBanned.md +++ b/old_docs/API_docs_v72/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_editPhoto.md b/old_docs/API_docs_v72/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v72/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v72/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_editTitle.md b/old_docs/API_docs_v72/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v72/methods/channels_editTitle.md +++ b/old_docs/API_docs_v72/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_exportInvite.md b/old_docs/API_docs_v72/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v72/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v72/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_exportMessageLink.md b/old_docs/API_docs_v72/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v72/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v72/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v72/methods/channels_getAdminLog.md b/old_docs/API_docs_v72/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v72/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v72/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_getChannels.md b/old_docs/API_docs_v72/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v72/methods/channels_getChannels.md +++ b/old_docs/API_docs_v72/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_getMessages.md b/old_docs/API_docs_v72/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v72/methods/channels_getMessages.md +++ b/old_docs/API_docs_v72/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/channels_getParticipant.md b/old_docs/API_docs_v72/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v72/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v72/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_getParticipants.md b/old_docs/API_docs_v72/methods/channels_getParticipants.md index 00446bf1..0ab83257 100644 --- a/old_docs/API_docs_v72/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v72/methods/channels_getParticipants.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_inviteToChannel.md b/old_docs/API_docs_v72/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v72/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v72/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_joinChannel.md b/old_docs/API_docs_v72/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v72/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v72/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_leaveChannel.md b/old_docs/API_docs_v72/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v72/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v72/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_readHistory.md b/old_docs/API_docs_v72/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v72/methods/channels_readHistory.md +++ b/old_docs/API_docs_v72/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_readMessageContents.md b/old_docs/API_docs_v72/methods/channels_readMessageContents.md index f0addc30..51fffda5 100644 --- a/old_docs/API_docs_v72/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v72/methods/channels_readMessageContents.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_reportSpam.md b/old_docs/API_docs_v72/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v72/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v72/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_setStickers.md b/old_docs/API_docs_v72/methods/channels_setStickers.md index 8557a723..421b3ec1 100644 --- a/old_docs/API_docs_v72/methods/channels_setStickers.md +++ b/old_docs/API_docs_v72/methods/channels_setStickers.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_toggleInvites.md b/old_docs/API_docs_v72/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v72/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v72/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md index cc48c100..c25f6358 100644 --- a/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v72/methods/channels_togglePreHistoryHidden.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_toggleSignatures.md b/old_docs/API_docs_v72/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v72/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v72/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v72/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/channels_updateUsername.md b/old_docs/API_docs_v72/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v72/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v72/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_block.md b/old_docs/API_docs_v72/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v72/methods/contacts_block.md +++ b/old_docs/API_docs_v72/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_deleteContact.md b/old_docs/API_docs_v72/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v72/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v72/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_deleteContacts.md b/old_docs/API_docs_v72/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v72/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v72/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_getBlocked.md b/old_docs/API_docs_v72/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v72/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v72/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_getContacts.md b/old_docs/API_docs_v72/methods/contacts_getContacts.md index 58c49847..48634fbb 100644 --- a/old_docs/API_docs_v72/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v72/methods/contacts_getContacts.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_getTopPeers.md b/old_docs/API_docs_v72/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v72/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v72/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_importCard.md b/old_docs/API_docs_v72/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v72/methods/contacts_importCard.md +++ b/old_docs/API_docs_v72/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_importContacts.md b/old_docs/API_docs_v72/methods/contacts_importContacts.md index 6aee0ac0..eddbe116 100644 --- a/old_docs/API_docs_v72/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v72/methods/contacts_importContacts.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v72/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_search.md b/old_docs/API_docs_v72/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v72/methods/contacts_search.md +++ b/old_docs/API_docs_v72/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contacts_unblock.md b/old_docs/API_docs_v72/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v72/methods/contacts_unblock.md +++ b/old_docs/API_docs_v72/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md b/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md index 4b391435..5761cdc8 100644 --- a/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md +++ b/old_docs/API_docs_v72/methods/contest_saveDeveloperInfo.md @@ -11,13 +11,13 @@ Save developer info for telegram contest ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|vk\_id|[int](../types/int.md) | Yes|VK user ID| -|name|[string](../types/string.md) | Yes|Name| -|phone\_number|[string](../types/string.md) | Yes|Phone number| -|age|[int](../types/int.md) | Yes|Age| -|city|[string](../types/string.md) | Yes|City| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|vk\_id|[int](../types/int.md) | VK user ID | Yes| +|name|[string](../types/string.md) | Name | Yes| +|phone\_number|[string](../types/string.md) | Phone number | Yes| +|age|[int](../types/int.md) | Age | Yes| +|city|[string](../types/string.md) | City | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/destroy_session.md b/old_docs/API_docs_v72/methods/destroy_session.md index 772427d6..6892d9a0 100644 --- a/old_docs/API_docs_v72/methods/destroy_session.md +++ b/old_docs/API_docs_v72/methods/destroy_session.md @@ -11,9 +11,9 @@ Destroy the current MTProto session ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|session\_id|[long](../types/long.md) | Yes|The session to destroy| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|session\_id|[long](../types/long.md) | The session to destroy | Yes| ### Return type: [DestroySessionRes](../types/DestroySessionRes.md) diff --git a/old_docs/API_docs_v72/methods/get_future_salts.md b/old_docs/API_docs_v72/methods/get_future_salts.md index 935b9367..94f0f8ca 100644 --- a/old_docs/API_docs_v72/methods/get_future_salts.md +++ b/old_docs/API_docs_v72/methods/get_future_salts.md @@ -11,9 +11,9 @@ Get future salts ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|num|[int](../types/int.md) | Yes|How many salts should be fetched| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|num|[int](../types/int.md) | How many salts should be fetched | Yes| ### Return type: [FutureSalts](../types/FutureSalts.md) diff --git a/old_docs/API_docs_v72/methods/help_getAppChangelog.md b/old_docs/API_docs_v72/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v72/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v72/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md index 5043cc42..27a451bb 100644 --- a/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v72/methods/help_getRecentMeUrls.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/help_saveAppLog.md b/old_docs/API_docs_v72/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v72/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v72/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/initConnection.md b/old_docs/API_docs_v72/methods/initConnection.md index de4c0c00..692a41e8 100644 --- a/old_docs/API_docs_v72/methods/initConnection.md +++ b/old_docs/API_docs_v72/methods/initConnection.md @@ -11,16 +11,16 @@ 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| -|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| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v72/methods/invokeAfterMsg.md b/old_docs/API_docs_v72/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v72/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v72/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/invokeAfterMsgs.md b/old_docs/API_docs_v72/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v72/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v72/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/invokeWithLayer.md b/old_docs/API_docs_v72/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v72/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v72/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v72/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/langpack_getDifference.md b/old_docs/API_docs_v72/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v72/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v72/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/langpack_getLangPack.md b/old_docs/API_docs_v72/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v72/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v72/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/langpack_getStrings.md b/old_docs/API_docs_v72/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v72/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v72/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/messages_addChatUser.md b/old_docs/API_docs_v72/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v72/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v72/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v72/methods/messages_checkChatInvite.md b/old_docs/API_docs_v72/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v72/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v72/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_createChat.md b/old_docs/API_docs_v72/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v72/methods/messages_createChat.md +++ b/old_docs/API_docs_v72/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_deleteChatUser.md b/old_docs/API_docs_v72/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v72/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_deleteHistory.md b/old_docs/API_docs_v72/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v72/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v72/methods/messages_deleteMessages.md b/old_docs/API_docs_v72/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v72/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v72/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v72/methods/messages_editChatAdmin.md b/old_docs/API_docs_v72/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v72/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_editChatPhoto.md b/old_docs/API_docs_v72/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v72/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_editChatTitle.md b/old_docs/API_docs_v72/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v72/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v72/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md index 37558618..4832e172 100644 --- a/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v72/methods/messages_editInlineBotMessage.md @@ -11,13 +11,13 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v72/methods/messages_editMessage.md b/old_docs/API_docs_v72/methods/messages_editMessage.md index b4f48e8d..d133507e 100644 --- a/old_docs/API_docs_v72/methods/messages_editMessage.md +++ b/old_docs/API_docs_v72/methods/messages_editMessage.md @@ -11,17 +11,17 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_exportChatInvite.md b/old_docs/API_docs_v72/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v72/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v72/methods/messages_faveSticker.md b/old_docs/API_docs_v72/methods/messages_faveSticker.md index 05c04983..302957c5 100644 --- a/old_docs/API_docs_v72/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v72/methods/messages_faveSticker.md @@ -11,10 +11,10 @@ Add a sticker to favorites ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional| +|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_forwardMessage.md b/old_docs/API_docs_v72/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v72/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v72/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_forwardMessages.md b/old_docs/API_docs_v72/methods/messages_forwardMessages.md index 95b236d8..99815a44 100644 --- a/old_docs/API_docs_v72/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v72/methods/messages_forwardMessages.md @@ -11,14 +11,14 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAllChats.md b/old_docs/API_docs_v72/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v72/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAllStickers.md b/old_docs/API_docs_v72/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v72/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v72/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v72/methods/messages_getChats.md b/old_docs/API_docs_v72/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v72/methods/messages_getChats.md +++ b/old_docs/API_docs_v72/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/messages_getCommonChats.md b/old_docs/API_docs_v72/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v72/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v72/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v72/methods/messages_getDialogs.md b/old_docs/API_docs_v72/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v72/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v72/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v72/methods/messages_getFavedStickers.md b/old_docs/API_docs_v72/methods/messages_getFavedStickers.md index cae141f4..4ea69f9f 100644 --- a/old_docs/API_docs_v72/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getFavedStickers.md @@ -11,9 +11,9 @@ Get favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getGameHighScores.md b/old_docs/API_docs_v72/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v72/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v72/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v72/methods/messages_getHistory.md b/old_docs/API_docs_v72/methods/messages_getHistory.md index 4c65c012..76d20b70 100644 --- a/old_docs/API_docs_v72/methods/messages_getHistory.md +++ b/old_docs/API_docs_v72/methods/messages_getHistory.md @@ -11,15 +11,15 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v72/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v72/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMaskStickers.md b/old_docs/API_docs_v72/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v72/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessageEditData.md b/old_docs/API_docs_v72/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v72/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessages.md b/old_docs/API_docs_v72/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessages.md +++ b/old_docs/API_docs_v72/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getMessagesViews.md b/old_docs/API_docs_v72/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v72/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v72/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getPeerSettings.md b/old_docs/API_docs_v72/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v72/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v72/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v72/methods/messages_getRecentLocations.md b/old_docs/API_docs_v72/methods/messages_getRecentLocations.md index c24f48f9..c9037187 100644 --- a/old_docs/API_docs_v72/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v72/methods/messages_getRecentLocations.md @@ -11,10 +11,10 @@ Get recent locations ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to search locations | Optional| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getRecentStickers.md b/old_docs/API_docs_v72/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v72/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v72/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v72/methods/messages_getSavedGifs.md b/old_docs/API_docs_v72/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v72/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v72/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v72/methods/messages_getStickerSet.md b/old_docs/API_docs_v72/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v72/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md index 88e895e4..9b221db9 100644 --- a/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v72/methods/messages_getUnreadMentions.md @@ -11,14 +11,14 @@ Get unread mentions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[int](../types/int.md) | Yes|The offset| -|add\_offset|[int](../types/int.md) | Yes|The additional offset| -|limit|[int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to get unread mentions | Optional| +|offset\_id|[int](../types/int.md) | The offset | Yes| +|add\_offset|[int](../types/int.md) | The additional offset | Yes| +|limit|[int](../types/int.md) | The number of results to fetch | Yes| +|max\_id|[int](../types/int.md) | The maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | The minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_getWebPage.md b/old_docs/API_docs_v72/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v72/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v72/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v72/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v72/methods/messages_hideReportSpam.md b/old_docs/API_docs_v72/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v72/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v72/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_importChatInvite.md b/old_docs/API_docs_v72/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v72/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v72/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_installStickerSet.md b/old_docs/API_docs_v72/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v72/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v72/methods/messages_migrateChat.md b/old_docs/API_docs_v72/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v72/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v72/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v72/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v72/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_readHistory.md b/old_docs/API_docs_v72/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v72/methods/messages_readHistory.md +++ b/old_docs/API_docs_v72/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v72/methods/messages_readMentions.md b/old_docs/API_docs_v72/methods/messages_readMentions.md index c58cb06a..31874ee6 100644 --- a/old_docs/API_docs_v72/methods/messages_readMentions.md +++ b/old_docs/API_docs_v72/methods/messages_readMentions.md @@ -11,9 +11,9 @@ Mark mentions as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v72/methods/messages_readMessageContents.md b/old_docs/API_docs_v72/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v72/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v72/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v72/methods/messages_receivedMessages.md b/old_docs/API_docs_v72/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v72/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v72/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v72/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v72/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v72/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_reportSpam.md b/old_docs/API_docs_v72/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v72/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v72/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_saveDraft.md b/old_docs/API_docs_v72/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v72/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v72/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v72/methods/messages_saveGif.md b/old_docs/API_docs_v72/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v72/methods/messages_saveGif.md +++ b/old_docs/API_docs_v72/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v72/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_search.md b/old_docs/API_docs_v72/methods/messages_search.md index a0907b88..159f893b 100644 --- a/old_docs/API_docs_v72/methods/messages_search.md +++ b/old_docs/API_docs_v72/methods/messages_search.md @@ -11,19 +11,19 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|min\_id|[int](../types/int.md) | Minumum message id to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_searchGifs.md b/old_docs/API_docs_v72/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v72/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v72/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v72/methods/messages_searchGlobal.md b/old_docs/API_docs_v72/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v72/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v72/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendEncrypted.md b/old_docs/API_docs_v72/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v72/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v72/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_sendMedia.md b/old_docs/API_docs_v72/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v72/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v72/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v72/methods/messages_sendMessage.md b/old_docs/API_docs_v72/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v72/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v72/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v72/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v72/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v72/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v72/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v72/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setGameScore.md b/old_docs/API_docs_v72/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v72/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v72/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v72/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v72/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_setTyping.md b/old_docs/API_docs_v72/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v72/methods/messages_setTyping.md +++ b/old_docs/API_docs_v72/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_startBot.md b/old_docs/API_docs_v72/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v72/methods/messages_startBot.md +++ b/old_docs/API_docs_v72/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v72/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v72/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v72/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/messages_uploadMedia.md b/old_docs/API_docs_v72/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v72/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v72/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/payments_getPaymentForm.md b/old_docs/API_docs_v72/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v72/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v72/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v72/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v72/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v72/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v72/methods/phone_receivedCall.md b/old_docs/API_docs_v72/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v72/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v72/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/phone_saveCallDebug.md b/old_docs/API_docs_v72/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v72/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v72/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v72/methods/phone_setCallRating.md b/old_docs/API_docs_v72/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v72/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v72/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v72/methods/photos_deletePhotos.md b/old_docs/API_docs_v72/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v72/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v72/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v72/methods/photos_getUserPhotos.md b/old_docs/API_docs_v72/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v72/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v72/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v72/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v72/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v72/methods/ping.md b/old_docs/API_docs_v72/methods/ping.md index dadae42f..d07839e4 100644 --- a/old_docs/API_docs_v72/methods/ping.md +++ b/old_docs/API_docs_v72/methods/ping.md @@ -11,9 +11,9 @@ pings the server ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v72/methods/ping_delay_disconnect.md b/old_docs/API_docs_v72/methods/ping_delay_disconnect.md index 22baa3bd..9b89e38d 100644 --- a/old_docs/API_docs_v72/methods/ping_delay_disconnect.md +++ b/old_docs/API_docs_v72/methods/ping_delay_disconnect.md @@ -11,10 +11,10 @@ Pings the server and causes disconection if the same method is not called within ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|ping\_id|[long](../types/long.md) | Yes|Ping ID| -|disconnect\_delay|[int](../types/int.md) | Yes|Disconection delay| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|ping\_id|[long](../types/long.md) | Ping ID | Yes| +|disconnect\_delay|[int](../types/int.md) | Disconection delay | Yes| ### Return type: [Pong](../types/Pong.md) diff --git a/old_docs/API_docs_v72/methods/req_DH_params.md b/old_docs/API_docs_v72/methods/req_DH_params.md index 89140510..54dd35a0 100644 --- a/old_docs/API_docs_v72/methods/req_DH_params.md +++ b/old_docs/API_docs_v72/methods/req_DH_params.md @@ -11,14 +11,14 @@ Requests Diffie-hellman parameters for key exchange ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|p|[string](../types/string.md) | Yes|factorized p from pq| -|q|[string](../types/string.md) | Yes|factorized q from pq| -|public\_key\_fingerprint|[long](../types/long.md) | Yes|Server RSA fingerprint| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|p|[string](../types/string.md) | factorized p from pq | Yes| +|q|[string](../types/string.md) | factorized q from pq | Yes| +|public\_key\_fingerprint|[long](../types/long.md) | Server RSA fingerprint | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Server\_DH\_Params](../types/Server_DH_Params.md) diff --git a/old_docs/API_docs_v72/methods/req_pq.md b/old_docs/API_docs_v72/methods/req_pq.md index 9b48fcdc..64da6ef7 100644 --- a/old_docs/API_docs_v72/methods/req_pq.md +++ b/old_docs/API_docs_v72/methods/req_pq.md @@ -11,9 +11,9 @@ Requests PQ for factorization ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| ### Return type: [ResPQ](../types/ResPQ.md) diff --git a/old_docs/API_docs_v72/methods/rpc_drop_answer.md b/old_docs/API_docs_v72/methods/rpc_drop_answer.md index 3842f2d7..8e08d16b 100644 --- a/old_docs/API_docs_v72/methods/rpc_drop_answer.md +++ b/old_docs/API_docs_v72/methods/rpc_drop_answer.md @@ -11,9 +11,9 @@ Do not send answer to provided request ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|req\_msg\_id|[long](../types/long.md) | Yes|The message ID of the request| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|req\_msg\_id|[long](../types/long.md) | The message ID of the request | Yes| ### Return type: [RpcDropAnswer](../types/RpcDropAnswer.md) diff --git a/old_docs/API_docs_v72/methods/set_client_DH_params.md b/old_docs/API_docs_v72/methods/set_client_DH_params.md index 79a43a88..41bbb00f 100644 --- a/old_docs/API_docs_v72/methods/set_client_DH_params.md +++ b/old_docs/API_docs_v72/methods/set_client_DH_params.md @@ -11,11 +11,11 @@ Sets client diffie-hellman parameters ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security| -|server\_nonce|[int128](../types/int128.md) | Yes|Random number for cryptographic security, given by server| -|encrypted\_data|[string](../types/string.md) | Yes|Encrypted message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|nonce|[int128](../types/int128.md) | Random number for cryptographic security | Yes| +|server\_nonce|[int128](../types/int128.md) | Random number for cryptographic security, given by server | Yes| +|encrypted\_data|[string](../types/string.md) | Encrypted message | Yes| ### Return type: [Set\_client\_DH\_params\_answer](../types/Set_client_DH_params_answer.md) diff --git a/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v72/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v72/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/stickers_createStickerSet.md b/old_docs/API_docs_v72/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v72/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v72/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v72/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v72/methods/upload_getWebFile.md b/old_docs/API_docs_v72/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v72/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v72/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v72/methods/users_getUsers.md b/old_docs/API_docs_v72/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v72/methods/users_getUsers.md +++ b/old_docs/API_docs_v72/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v73/methods/account_changePhone.md b/old_docs/API_docs_v73/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v73/methods/account_changePhone.md +++ b/old_docs/API_docs_v73/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_checkUsername.md b/old_docs/API_docs_v73/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v73/methods/account_checkUsername.md +++ b/old_docs/API_docs_v73/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_confirmPhone.md b/old_docs/API_docs_v73/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v73/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v73/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_deleteAccount.md b/old_docs/API_docs_v73/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v73/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v73/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_getNotifySettings.md b/old_docs/API_docs_v73/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v73/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v73/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_getPasswordSettings.md b/old_docs/API_docs_v73/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v73/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v73/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_getPrivacy.md b/old_docs/API_docs_v73/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v73/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v73/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_getTmpPassword.md b/old_docs/API_docs_v73/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v73/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v73/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_registerDevice.md b/old_docs/API_docs_v73/methods/account_registerDevice.md index 86f95e55..25549dab 100644 --- a/old_docs/API_docs_v73/methods/account_registerDevice.md +++ b/old_docs/API_docs_v73/methods/account_registerDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/account_reportPeer.md b/old_docs/API_docs_v73/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v73/methods/account_reportPeer.md +++ b/old_docs/API_docs_v73/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_resetAuthorization.md b/old_docs/API_docs_v73/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v73/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v73/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v73/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v73/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_setAccountTTL.md b/old_docs/API_docs_v73/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v73/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v73/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_setPrivacy.md b/old_docs/API_docs_v73/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v73/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v73/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_unregisterDevice.md b/old_docs/API_docs_v73/methods/account_unregisterDevice.md index d327c271..96db2eb2 100644 --- a/old_docs/API_docs_v73/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v73/methods/account_unregisterDevice.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v73/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_updateNotifySettings.md b/old_docs/API_docs_v73/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v73/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v73/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v73/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_updateProfile.md b/old_docs/API_docs_v73/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v73/methods/account_updateProfile.md +++ b/old_docs/API_docs_v73/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_updateStatus.md b/old_docs/API_docs_v73/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v73/methods/account_updateStatus.md +++ b/old_docs/API_docs_v73/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/account_updateUsername.md b/old_docs/API_docs_v73/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v73/methods/account_updateUsername.md +++ b/old_docs/API_docs_v73/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/auth_cancelCode.md b/old_docs/API_docs_v73/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v73/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v73/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/auth_checkPhone.md b/old_docs/API_docs_v73/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v73/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v73/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v73/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/auth_recoverPassword.md b/old_docs/API_docs_v73/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v73/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v73/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/auth_resendCode.md b/old_docs/API_docs_v73/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v73/methods/auth_resendCode.md +++ b/old_docs/API_docs_v73/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/auth_sendInvites.md b/old_docs/API_docs_v73/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v73/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v73/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v73/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v73/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_checkUsername.md b/old_docs/API_docs_v73/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v73/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v73/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_createChannel.md b/old_docs/API_docs_v73/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v73/methods/channels_createChannel.md +++ b/old_docs/API_docs_v73/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_deleteChannel.md b/old_docs/API_docs_v73/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v73/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_deleteHistory.md b/old_docs/API_docs_v73/methods/channels_deleteHistory.md index d33bdbe0..ea331b8b 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v73/methods/channels_deleteHistory.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_deleteMessages.md b/old_docs/API_docs_v73/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v73/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v73/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_editAbout.md b/old_docs/API_docs_v73/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v73/methods/channels_editAbout.md +++ b/old_docs/API_docs_v73/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_editAdmin.md b/old_docs/API_docs_v73/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v73/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v73/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_editBanned.md b/old_docs/API_docs_v73/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v73/methods/channels_editBanned.md +++ b/old_docs/API_docs_v73/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_editPhoto.md b/old_docs/API_docs_v73/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v73/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v73/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_editTitle.md b/old_docs/API_docs_v73/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v73/methods/channels_editTitle.md +++ b/old_docs/API_docs_v73/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_exportInvite.md b/old_docs/API_docs_v73/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v73/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v73/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_exportMessageLink.md b/old_docs/API_docs_v73/methods/channels_exportMessageLink.md index f2c7deff..f42068f4 100644 --- a/old_docs/API_docs_v73/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v73/methods/channels_exportMessageLink.md @@ -11,10 +11,10 @@ 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| +| 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| ### Return type: [ExportedMessageLink](../types/ExportedMessageLink.md) diff --git a/old_docs/API_docs_v73/methods/channels_getAdminLog.md b/old_docs/API_docs_v73/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v73/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v73/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_getChannels.md b/old_docs/API_docs_v73/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v73/methods/channels_getChannels.md +++ b/old_docs/API_docs_v73/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_getMessages.md b/old_docs/API_docs_v73/methods/channels_getMessages.md index 6d960609..217757eb 100644 --- a/old_docs/API_docs_v73/methods/channels_getMessages.md +++ b/old_docs/API_docs_v73/methods/channels_getMessages.md @@ -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 [int](../types/int.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 [int](../types/int.md) | The message IDs | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/channels_getParticipant.md b/old_docs/API_docs_v73/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v73/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v73/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_getParticipants.md b/old_docs/API_docs_v73/methods/channels_getParticipants.md index 00446bf1..0ab83257 100644 --- a/old_docs/API_docs_v73/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v73/methods/channels_getParticipants.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_inviteToChannel.md b/old_docs/API_docs_v73/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v73/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v73/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_joinChannel.md b/old_docs/API_docs_v73/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v73/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v73/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_leaveChannel.md b/old_docs/API_docs_v73/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v73/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v73/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_readHistory.md b/old_docs/API_docs_v73/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v73/methods/channels_readHistory.md +++ b/old_docs/API_docs_v73/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_readMessageContents.md b/old_docs/API_docs_v73/methods/channels_readMessageContents.md index f0addc30..51fffda5 100644 --- a/old_docs/API_docs_v73/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v73/methods/channels_readMessageContents.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_reportSpam.md b/old_docs/API_docs_v73/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v73/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v73/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_setStickers.md b/old_docs/API_docs_v73/methods/channels_setStickers.md index 8557a723..421b3ec1 100644 --- a/old_docs/API_docs_v73/methods/channels_setStickers.md +++ b/old_docs/API_docs_v73/methods/channels_setStickers.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_toggleInvites.md b/old_docs/API_docs_v73/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v73/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v73/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md index cc48c100..c25f6358 100644 --- a/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v73/methods/channels_togglePreHistoryHidden.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_toggleSignatures.md b/old_docs/API_docs_v73/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v73/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v73/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v73/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/channels_updateUsername.md b/old_docs/API_docs_v73/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v73/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v73/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_block.md b/old_docs/API_docs_v73/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v73/methods/contacts_block.md +++ b/old_docs/API_docs_v73/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_deleteContact.md b/old_docs/API_docs_v73/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v73/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v73/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_deleteContacts.md b/old_docs/API_docs_v73/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v73/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v73/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_getBlocked.md b/old_docs/API_docs_v73/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v73/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v73/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_getContacts.md b/old_docs/API_docs_v73/methods/contacts_getContacts.md index 58c49847..48634fbb 100644 --- a/old_docs/API_docs_v73/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v73/methods/contacts_getContacts.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_getTopPeers.md b/old_docs/API_docs_v73/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v73/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v73/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_importCard.md b/old_docs/API_docs_v73/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v73/methods/contacts_importCard.md +++ b/old_docs/API_docs_v73/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_importContacts.md b/old_docs/API_docs_v73/methods/contacts_importContacts.md index 6aee0ac0..eddbe116 100644 --- a/old_docs/API_docs_v73/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v73/methods/contacts_importContacts.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v73/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_search.md b/old_docs/API_docs_v73/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v73/methods/contacts_search.md +++ b/old_docs/API_docs_v73/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/contacts_unblock.md b/old_docs/API_docs_v73/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v73/methods/contacts_unblock.md +++ b/old_docs/API_docs_v73/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/help_getAppChangelog.md b/old_docs/API_docs_v73/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v73/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v73/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md index 5043cc42..27a451bb 100644 --- a/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v73/methods/help_getRecentMeUrls.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/help_saveAppLog.md b/old_docs/API_docs_v73/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v73/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v73/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v73/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/initConnection.md b/old_docs/API_docs_v73/methods/initConnection.md index de4c0c00..692a41e8 100644 --- a/old_docs/API_docs_v73/methods/initConnection.md +++ b/old_docs/API_docs_v73/methods/initConnection.md @@ -11,16 +11,16 @@ 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| -|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| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v73/methods/invokeAfterMsg.md b/old_docs/API_docs_v73/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v73/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v73/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/invokeAfterMsgs.md b/old_docs/API_docs_v73/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v73/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v73/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/invokeWithLayer.md b/old_docs/API_docs_v73/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v73/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v73/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v73/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/langpack_getDifference.md b/old_docs/API_docs_v73/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v73/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v73/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/langpack_getLangPack.md b/old_docs/API_docs_v73/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v73/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v73/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/langpack_getStrings.md b/old_docs/API_docs_v73/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v73/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v73/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/messages_addChatUser.md b/old_docs/API_docs_v73/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v73/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v73/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v73/methods/messages_checkChatInvite.md b/old_docs/API_docs_v73/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v73/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v73/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_createChat.md b/old_docs/API_docs_v73/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v73/methods/messages_createChat.md +++ b/old_docs/API_docs_v73/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_deleteChatUser.md b/old_docs/API_docs_v73/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v73/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_deleteHistory.md b/old_docs/API_docs_v73/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v73/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v73/methods/messages_deleteMessages.md b/old_docs/API_docs_v73/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v73/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v73/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v73/methods/messages_editChatAdmin.md b/old_docs/API_docs_v73/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v73/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_editChatPhoto.md b/old_docs/API_docs_v73/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v73/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_editChatTitle.md b/old_docs/API_docs_v73/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v73/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v73/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md index 88a4a447..0598cf21 100644 --- a/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v73/methods/messages_editInlineBotMessage.md @@ -11,16 +11,16 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_editMessage.md b/old_docs/API_docs_v73/methods/messages_editMessage.md index b4f48e8d..d133507e 100644 --- a/old_docs/API_docs_v73/methods/messages_editMessage.md +++ b/old_docs/API_docs_v73/methods/messages_editMessage.md @@ -11,17 +11,17 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_exportChatInvite.md b/old_docs/API_docs_v73/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v73/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v73/methods/messages_faveSticker.md b/old_docs/API_docs_v73/methods/messages_faveSticker.md index 05c04983..302957c5 100644 --- a/old_docs/API_docs_v73/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v73/methods/messages_faveSticker.md @@ -11,10 +11,10 @@ Add a sticker to favorites ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional| +|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_forwardMessage.md b/old_docs/API_docs_v73/methods/messages_forwardMessage.md index b0f5cd67..586670b8 100644 --- a/old_docs/API_docs_v73/methods/messages_forwardMessage.md +++ b/old_docs/API_docs_v73/methods/messages_forwardMessage.md @@ -11,10 +11,10 @@ Forward message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the message| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the message | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_forwardMessages.md b/old_docs/API_docs_v73/methods/messages_forwardMessages.md index e0091c2e..3372333c 100644 --- a/old_docs/API_docs_v73/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v73/methods/messages_forwardMessages.md @@ -11,15 +11,15 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|grouped|[Bool](../types/Bool.md) | Set to true if forwarding albums | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAllChats.md b/old_docs/API_docs_v73/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v73/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAllStickers.md b/old_docs/API_docs_v73/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v73/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v73/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v73/methods/messages_getChats.md b/old_docs/API_docs_v73/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v73/methods/messages_getChats.md +++ b/old_docs/API_docs_v73/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/messages_getCommonChats.md b/old_docs/API_docs_v73/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v73/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v73/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v73/methods/messages_getDialogs.md b/old_docs/API_docs_v73/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v73/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v73/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v73/methods/messages_getFavedStickers.md b/old_docs/API_docs_v73/methods/messages_getFavedStickers.md index cae141f4..4ea69f9f 100644 --- a/old_docs/API_docs_v73/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getFavedStickers.md @@ -11,9 +11,9 @@ Get favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getGameHighScores.md b/old_docs/API_docs_v73/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v73/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v73/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v73/methods/messages_getHistory.md b/old_docs/API_docs_v73/methods/messages_getHistory.md index 0d6eee5a..7864e4ad 100644 --- a/old_docs/API_docs_v73/methods/messages_getHistory.md +++ b/old_docs/API_docs_v73/methods/messages_getHistory.md @@ -11,16 +11,16 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| -|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| +|hash|[int](../types/int.md) | hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v73/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v73/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMaskStickers.md b/old_docs/API_docs_v73/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v73/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessageEditData.md b/old_docs/API_docs_v73/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v73/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessages.md b/old_docs/API_docs_v73/methods/messages_getMessages.md index ea63f3d2..e9bf53a4 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessages.md +++ b/old_docs/API_docs_v73/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getMessagesViews.md b/old_docs/API_docs_v73/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v73/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v73/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getPeerSettings.md b/old_docs/API_docs_v73/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v73/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v73/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v73/methods/messages_getRecentLocations.md b/old_docs/API_docs_v73/methods/messages_getRecentLocations.md index c24f48f9..c9037187 100644 --- a/old_docs/API_docs_v73/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v73/methods/messages_getRecentLocations.md @@ -11,10 +11,10 @@ Get recent locations ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to search locations | Optional| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getRecentStickers.md b/old_docs/API_docs_v73/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v73/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v73/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v73/methods/messages_getSavedGifs.md b/old_docs/API_docs_v73/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v73/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v73/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v73/methods/messages_getStickerSet.md b/old_docs/API_docs_v73/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v73/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md index 88e895e4..9b221db9 100644 --- a/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v73/methods/messages_getUnreadMentions.md @@ -11,14 +11,14 @@ Get unread mentions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[int](../types/int.md) | Yes|The offset| -|add\_offset|[int](../types/int.md) | Yes|The additional offset| -|limit|[int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to get unread mentions | Optional| +|offset\_id|[int](../types/int.md) | The offset | Yes| +|add\_offset|[int](../types/int.md) | The additional offset | Yes| +|limit|[int](../types/int.md) | The number of results to fetch | Yes| +|max\_id|[int](../types/int.md) | The maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | The minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_getWebPage.md b/old_docs/API_docs_v73/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v73/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v73/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md index 903b4976..8475c8f5 100644 --- a/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v73/methods/messages_getWebPagePreview.md @@ -11,9 +11,9 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v73/methods/messages_hideReportSpam.md b/old_docs/API_docs_v73/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v73/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v73/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_importChatInvite.md b/old_docs/API_docs_v73/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v73/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v73/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_installStickerSet.md b/old_docs/API_docs_v73/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v73/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v73/methods/messages_migrateChat.md b/old_docs/API_docs_v73/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v73/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v73/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v73/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v73/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_readHistory.md b/old_docs/API_docs_v73/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v73/methods/messages_readHistory.md +++ b/old_docs/API_docs_v73/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v73/methods/messages_readMentions.md b/old_docs/API_docs_v73/methods/messages_readMentions.md index c58cb06a..31874ee6 100644 --- a/old_docs/API_docs_v73/methods/messages_readMentions.md +++ b/old_docs/API_docs_v73/methods/messages_readMentions.md @@ -11,9 +11,9 @@ Mark mentions as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v73/methods/messages_readMessageContents.md b/old_docs/API_docs_v73/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v73/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v73/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v73/methods/messages_receivedMessages.md b/old_docs/API_docs_v73/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v73/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v73/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v73/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v73/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v73/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_reportSpam.md b/old_docs/API_docs_v73/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v73/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v73/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_saveDraft.md b/old_docs/API_docs_v73/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v73/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v73/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v73/methods/messages_saveGif.md b/old_docs/API_docs_v73/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v73/methods/messages_saveGif.md +++ b/old_docs/API_docs_v73/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v73/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_search.md b/old_docs/API_docs_v73/methods/messages_search.md index a0907b88..159f893b 100644 --- a/old_docs/API_docs_v73/methods/messages_search.md +++ b/old_docs/API_docs_v73/methods/messages_search.md @@ -11,19 +11,19 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|min\_id|[int](../types/int.md) | Minumum message id to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_searchGifs.md b/old_docs/API_docs_v73/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v73/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v73/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v73/methods/messages_searchGlobal.md b/old_docs/API_docs_v73/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v73/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v73/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendEncrypted.md b/old_docs/API_docs_v73/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v73/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v73/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendMedia.md b/old_docs/API_docs_v73/methods/messages_sendMedia.md index 22c3f7ed..2290e52e 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v73/methods/messages_sendMedia.md @@ -11,15 +11,15 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| ### Return type: [Updates](../types/Updates.md) @@ -100,6 +100,7 @@ You can provide bot API reply_markup objects here. |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v73/methods/messages_sendMessage.md b/old_docs/API_docs_v73/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v73/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md b/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md index 92baa8ab..115d2f60 100644 --- a/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md +++ b/old_docs/API_docs_v73/methods/messages_sendMultiMedia.md @@ -11,14 +11,14 @@ Send an album ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notification? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the album | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | The album | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v73/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v73/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v73/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v73/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v73/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setGameScore.md b/old_docs/API_docs_v73/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v73/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v73/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v73/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v73/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_setTyping.md b/old_docs/API_docs_v73/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v73/methods/messages_setTyping.md +++ b/old_docs/API_docs_v73/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_startBot.md b/old_docs/API_docs_v73/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v73/methods/messages_startBot.md +++ b/old_docs/API_docs_v73/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v73/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v73/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v73/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md b/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md index abb08479..91159bb5 100644 --- a/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md +++ b/old_docs/API_docs_v73/methods/messages_uploadEncryptedFile.md @@ -11,10 +11,10 @@ Upload a secret chat file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to upload the media| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to upload the media | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file | Optional| ### Return type: [EncryptedFile](../types/EncryptedFile.md) diff --git a/old_docs/API_docs_v73/methods/messages_uploadMedia.md b/old_docs/API_docs_v73/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v73/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v73/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/payments_getPaymentForm.md b/old_docs/API_docs_v73/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v73/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v73/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v73/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v73/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v73/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v73/methods/phone_receivedCall.md b/old_docs/API_docs_v73/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v73/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v73/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/phone_saveCallDebug.md b/old_docs/API_docs_v73/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v73/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v73/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v73/methods/phone_setCallRating.md b/old_docs/API_docs_v73/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v73/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v73/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v73/methods/photos_deletePhotos.md b/old_docs/API_docs_v73/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v73/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v73/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v73/methods/photos_getUserPhotos.md b/old_docs/API_docs_v73/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v73/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v73/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v73/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v73/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v73/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v73/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/stickers_createStickerSet.md b/old_docs/API_docs_v73/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v73/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v73/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v73/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v73/methods/upload_getWebFile.md b/old_docs/API_docs_v73/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v73/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v73/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v73/methods/users_getUsers.md b/old_docs/API_docs_v73/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v73/methods/users_getUsers.md +++ b/old_docs/API_docs_v73/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v75/methods/account_changePhone.md b/old_docs/API_docs_v75/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v75/methods/account_changePhone.md +++ b/old_docs/API_docs_v75/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_checkUsername.md b/old_docs/API_docs_v75/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v75/methods/account_checkUsername.md +++ b/old_docs/API_docs_v75/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_confirmPhone.md b/old_docs/API_docs_v75/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v75/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v75/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_deleteAccount.md b/old_docs/API_docs_v75/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v75/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v75/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_getNotifySettings.md b/old_docs/API_docs_v75/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v75/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v75/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_getPasswordSettings.md b/old_docs/API_docs_v75/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v75/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v75/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_getPrivacy.md b/old_docs/API_docs_v75/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v75/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v75/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_getTmpPassword.md b/old_docs/API_docs_v75/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v75/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v75/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_registerDevice.md b/old_docs/API_docs_v75/methods/account_registerDevice.md index d8fa1d68..44c829cd 100644 --- a/old_docs/API_docs_v75/methods/account_registerDevice.md +++ b/old_docs/API_docs_v75/methods/account_registerDevice.md @@ -11,12 +11,12 @@ 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?| -|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| +|other\_uids|Array of [int](../types/int.md) | Other UIDs | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/account_reportPeer.md b/old_docs/API_docs_v75/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v75/methods/account_reportPeer.md +++ b/old_docs/API_docs_v75/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_resetAuthorization.md b/old_docs/API_docs_v75/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v75/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v75/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_resetWebAuthorization.md b/old_docs/API_docs_v75/methods/account_resetWebAuthorization.md index 9d42f177..2d987787 100644 --- a/old_docs/API_docs_v75/methods/account_resetWebAuthorization.md +++ b/old_docs/API_docs_v75/methods/account_resetWebAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v75/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v75/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v75/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v75/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v75/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v75/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_setAccountTTL.md b/old_docs/API_docs_v75/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v75/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v75/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_setPrivacy.md b/old_docs/API_docs_v75/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v75/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v75/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_unregisterDevice.md b/old_docs/API_docs_v75/methods/account_unregisterDevice.md index 5da8c776..b20ec9f0 100644 --- a/old_docs/API_docs_v75/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v75/methods/account_unregisterDevice.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v75/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v75/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v75/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_updateNotifySettings.md b/old_docs/API_docs_v75/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v75/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v75/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v75/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v75/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v75/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_updateProfile.md b/old_docs/API_docs_v75/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v75/methods/account_updateProfile.md +++ b/old_docs/API_docs_v75/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_updateStatus.md b/old_docs/API_docs_v75/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v75/methods/account_updateStatus.md +++ b/old_docs/API_docs_v75/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/account_updateUsername.md b/old_docs/API_docs_v75/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v75/methods/account_updateUsername.md +++ b/old_docs/API_docs_v75/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/auth_cancelCode.md b/old_docs/API_docs_v75/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v75/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v75/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/auth_checkPhone.md b/old_docs/API_docs_v75/methods/auth_checkPhone.md index 3394ed76..fc566128 100644 --- a/old_docs/API_docs_v75/methods/auth_checkPhone.md +++ b/old_docs/API_docs_v75/methods/auth_checkPhone.md @@ -11,9 +11,9 @@ Check if this phone number is registered on telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_number|[string](../types/string.md) | Yes|The phone number to check| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_number|[string](../types/string.md) | The phone number to check | Yes| ### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md) diff --git a/old_docs/API_docs_v75/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v75/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v75/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v75/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/auth_recoverPassword.md b/old_docs/API_docs_v75/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v75/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v75/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/auth_resendCode.md b/old_docs/API_docs_v75/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v75/methods/auth_resendCode.md +++ b/old_docs/API_docs_v75/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/auth_sendInvites.md b/old_docs/API_docs_v75/methods/auth_sendInvites.md index 3dbeca79..5f8f06e6 100644 --- a/old_docs/API_docs_v75/methods/auth_sendInvites.md +++ b/old_docs/API_docs_v75/methods/auth_sendInvites.md @@ -11,10 +11,10 @@ Invite friends to telegram! ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|phone\_numbers|Array of [string](../types/string.md) | Yes|Phone numbers to invite| -|message|[string](../types/string.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|phone\_numbers|Array of [string](../types/string.md) | Phone numbers to invite | Yes| +|message|[string](../types/string.md) | The message to send | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v75/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v75/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v75/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v75/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v75/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v75/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_checkUsername.md b/old_docs/API_docs_v75/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v75/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v75/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_createChannel.md b/old_docs/API_docs_v75/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v75/methods/channels_createChannel.md +++ b/old_docs/API_docs_v75/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_deleteChannel.md b/old_docs/API_docs_v75/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v75/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v75/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_deleteHistory.md b/old_docs/API_docs_v75/methods/channels_deleteHistory.md index d33bdbe0..ea331b8b 100644 --- a/old_docs/API_docs_v75/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v75/methods/channels_deleteHistory.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_deleteMessages.md b/old_docs/API_docs_v75/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v75/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v75/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v75/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v75/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v75/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_editAbout.md b/old_docs/API_docs_v75/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v75/methods/channels_editAbout.md +++ b/old_docs/API_docs_v75/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_editAdmin.md b/old_docs/API_docs_v75/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v75/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v75/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_editBanned.md b/old_docs/API_docs_v75/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v75/methods/channels_editBanned.md +++ b/old_docs/API_docs_v75/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_editPhoto.md b/old_docs/API_docs_v75/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v75/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v75/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_editTitle.md b/old_docs/API_docs_v75/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v75/methods/channels_editTitle.md +++ b/old_docs/API_docs_v75/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_exportInvite.md b/old_docs/API_docs_v75/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v75/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v75/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_exportMessageLink.md b/old_docs/API_docs_v75/methods/channels_exportMessageLink.md index 595e4b70..3b6e7e9e 100644 --- a/old_docs/API_docs_v75/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v75/methods/channels_exportMessageLink.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_getAdminLog.md b/old_docs/API_docs_v75/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v75/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v75/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_getChannels.md b/old_docs/API_docs_v75/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v75/methods/channels_getChannels.md +++ b/old_docs/API_docs_v75/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_getMessages.md b/old_docs/API_docs_v75/methods/channels_getMessages.md index 2c2d822a..4f63c3a2 100644 --- a/old_docs/API_docs_v75/methods/channels_getMessages.md +++ b/old_docs/API_docs_v75/methods/channels_getMessages.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_getParticipant.md b/old_docs/API_docs_v75/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v75/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v75/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_getParticipants.md b/old_docs/API_docs_v75/methods/channels_getParticipants.md index 00446bf1..0ab83257 100644 --- a/old_docs/API_docs_v75/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v75/methods/channels_getParticipants.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_inviteToChannel.md b/old_docs/API_docs_v75/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v75/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v75/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_joinChannel.md b/old_docs/API_docs_v75/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v75/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v75/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_leaveChannel.md b/old_docs/API_docs_v75/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v75/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v75/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_readHistory.md b/old_docs/API_docs_v75/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v75/methods/channels_readHistory.md +++ b/old_docs/API_docs_v75/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_readMessageContents.md b/old_docs/API_docs_v75/methods/channels_readMessageContents.md index f0addc30..51fffda5 100644 --- a/old_docs/API_docs_v75/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v75/methods/channels_readMessageContents.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_reportSpam.md b/old_docs/API_docs_v75/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v75/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v75/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_setStickers.md b/old_docs/API_docs_v75/methods/channels_setStickers.md index 8557a723..421b3ec1 100644 --- a/old_docs/API_docs_v75/methods/channels_setStickers.md +++ b/old_docs/API_docs_v75/methods/channels_setStickers.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_toggleInvites.md b/old_docs/API_docs_v75/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v75/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v75/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v75/methods/channels_togglePreHistoryHidden.md index cc48c100..c25f6358 100644 --- a/old_docs/API_docs_v75/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v75/methods/channels_togglePreHistoryHidden.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_toggleSignatures.md b/old_docs/API_docs_v75/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v75/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v75/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v75/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v75/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v75/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/channels_updateUsername.md b/old_docs/API_docs_v75/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v75/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v75/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_block.md b/old_docs/API_docs_v75/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v75/methods/contacts_block.md +++ b/old_docs/API_docs_v75/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_deleteContact.md b/old_docs/API_docs_v75/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v75/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v75/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_deleteContacts.md b/old_docs/API_docs_v75/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v75/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v75/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_getBlocked.md b/old_docs/API_docs_v75/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v75/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v75/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_getContacts.md b/old_docs/API_docs_v75/methods/contacts_getContacts.md index 58c49847..48634fbb 100644 --- a/old_docs/API_docs_v75/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v75/methods/contacts_getContacts.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_getTopPeers.md b/old_docs/API_docs_v75/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v75/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v75/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_importCard.md b/old_docs/API_docs_v75/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v75/methods/contacts_importCard.md +++ b/old_docs/API_docs_v75/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_importContacts.md b/old_docs/API_docs_v75/methods/contacts_importContacts.md index 6aee0ac0..eddbe116 100644 --- a/old_docs/API_docs_v75/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v75/methods/contacts_importContacts.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v75/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v75/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v75/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_search.md b/old_docs/API_docs_v75/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v75/methods/contacts_search.md +++ b/old_docs/API_docs_v75/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/contacts_unblock.md b/old_docs/API_docs_v75/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v75/methods/contacts_unblock.md +++ b/old_docs/API_docs_v75/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/help_getAppChangelog.md b/old_docs/API_docs_v75/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v75/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v75/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v75/methods/help_getRecentMeUrls.md index 5043cc42..27a451bb 100644 --- a/old_docs/API_docs_v75/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v75/methods/help_getRecentMeUrls.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/help_saveAppLog.md b/old_docs/API_docs_v75/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v75/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v75/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v75/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v75/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v75/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/initConnection.md b/old_docs/API_docs_v75/methods/initConnection.md index de4c0c00..692a41e8 100644 --- a/old_docs/API_docs_v75/methods/initConnection.md +++ b/old_docs/API_docs_v75/methods/initConnection.md @@ -11,16 +11,16 @@ 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| -|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| +|query|[!X](../types/!X.md) | Nested query | Yes| ### Return type: [X](../types/X.md) diff --git a/old_docs/API_docs_v75/methods/invokeAfterMsg.md b/old_docs/API_docs_v75/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v75/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v75/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/invokeAfterMsgs.md b/old_docs/API_docs_v75/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v75/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v75/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/invokeWithLayer.md b/old_docs/API_docs_v75/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v75/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v75/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v75/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v75/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v75/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/langpack_getDifference.md b/old_docs/API_docs_v75/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v75/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v75/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/langpack_getLangPack.md b/old_docs/API_docs_v75/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v75/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v75/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/langpack_getStrings.md b/old_docs/API_docs_v75/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v75/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v75/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/messages_addChatUser.md b/old_docs/API_docs_v75/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v75/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v75/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v75/methods/messages_checkChatInvite.md b/old_docs/API_docs_v75/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v75/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v75/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v75/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v75/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v75/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v75/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_createChat.md b/old_docs/API_docs_v75/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v75/methods/messages_createChat.md +++ b/old_docs/API_docs_v75/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_deleteChatUser.md b/old_docs/API_docs_v75/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v75/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v75/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_deleteHistory.md b/old_docs/API_docs_v75/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v75/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v75/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v75/methods/messages_deleteMessages.md b/old_docs/API_docs_v75/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v75/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v75/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v75/methods/messages_editChatAdmin.md b/old_docs/API_docs_v75/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v75/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v75/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_editChatPhoto.md b/old_docs/API_docs_v75/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v75/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v75/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_editChatTitle.md b/old_docs/API_docs_v75/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v75/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v75/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v75/methods/messages_editInlineBotMessage.md index 88a4a447..0598cf21 100644 --- a/old_docs/API_docs_v75/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v75/methods/messages_editInlineBotMessage.md @@ -11,16 +11,16 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_editMessage.md b/old_docs/API_docs_v75/methods/messages_editMessage.md index b4f48e8d..d133507e 100644 --- a/old_docs/API_docs_v75/methods/messages_editMessage.md +++ b/old_docs/API_docs_v75/methods/messages_editMessage.md @@ -11,17 +11,17 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_exportChatInvite.md b/old_docs/API_docs_v75/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v75/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v75/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v75/methods/messages_faveSticker.md b/old_docs/API_docs_v75/methods/messages_faveSticker.md index 05c04983..302957c5 100644 --- a/old_docs/API_docs_v75/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v75/methods/messages_faveSticker.md @@ -11,10 +11,10 @@ Add a sticker to favorites ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional| +|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_forwardMessages.md b/old_docs/API_docs_v75/methods/messages_forwardMessages.md index e0091c2e..3372333c 100644 --- a/old_docs/API_docs_v75/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v75/methods/messages_forwardMessages.md @@ -11,15 +11,15 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|grouped|[Bool](../types/Bool.md) | Set to true if forwarding albums | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_getAllChats.md b/old_docs/API_docs_v75/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v75/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v75/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v75/methods/messages_getAllStickers.md b/old_docs/API_docs_v75/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v75/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v75/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v75/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v75/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v75/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v75/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v75/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v75/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v75/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v75/methods/messages_getChats.md b/old_docs/API_docs_v75/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v75/methods/messages_getChats.md +++ b/old_docs/API_docs_v75/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v75/methods/messages_getCommonChats.md b/old_docs/API_docs_v75/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v75/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v75/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v75/methods/messages_getDialogs.md b/old_docs/API_docs_v75/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v75/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v75/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v75/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v75/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v75/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v75/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v75/methods/messages_getFavedStickers.md b/old_docs/API_docs_v75/methods/messages_getFavedStickers.md index cae141f4..4ea69f9f 100644 --- a/old_docs/API_docs_v75/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getFavedStickers.md @@ -11,9 +11,9 @@ Get favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v75/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v75/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getGameHighScores.md b/old_docs/API_docs_v75/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v75/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v75/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v75/methods/messages_getHistory.md b/old_docs/API_docs_v75/methods/messages_getHistory.md index 0d6eee5a..7864e4ad 100644 --- a/old_docs/API_docs_v75/methods/messages_getHistory.md +++ b/old_docs/API_docs_v75/methods/messages_getHistory.md @@ -11,16 +11,16 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| -|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| +|hash|[int](../types/int.md) | hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v75/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v75/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v75/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v75/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v75/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v75/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v75/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v75/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v75/methods/messages_getMaskStickers.md b/old_docs/API_docs_v75/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v75/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getMessageEditData.md b/old_docs/API_docs_v75/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v75/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v75/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v75/methods/messages_getMessages.md b/old_docs/API_docs_v75/methods/messages_getMessages.md index c70d48c5..3cd40799 100644 --- a/old_docs/API_docs_v75/methods/messages_getMessages.md +++ b/old_docs/API_docs_v75/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v75/methods/messages_getMessagesViews.md b/old_docs/API_docs_v75/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v75/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v75/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v75/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v75/methods/messages_getPeerDialogs.md index de3d3a72..ca746b3b 100644 --- a/old_docs/API_docs_v75/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v75/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v75/methods/messages_getPeerSettings.md b/old_docs/API_docs_v75/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v75/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v75/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v75/methods/messages_getRecentLocations.md b/old_docs/API_docs_v75/methods/messages_getRecentLocations.md index c24f48f9..c9037187 100644 --- a/old_docs/API_docs_v75/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v75/methods/messages_getRecentLocations.md @@ -11,10 +11,10 @@ Get recent locations ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[int](../types/int.md) | Yes|Number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to search locations | Optional| +|limit|[int](../types/int.md) | Number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v75/methods/messages_getRecentStickers.md b/old_docs/API_docs_v75/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v75/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getSavedGifs.md b/old_docs/API_docs_v75/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v75/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v75/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v75/methods/messages_getStickerSet.md b/old_docs/API_docs_v75/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v75/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v75/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v75/methods/messages_getStickers.md b/old_docs/API_docs_v75/methods/messages_getStickers.md index d7779305..1d1aef51 100644 --- a/old_docs/API_docs_v75/methods/messages_getStickers.md +++ b/old_docs/API_docs_v75/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[string](../types/string.md) | Yes|0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[string](../types/string.md) | 0 or $MadelineProto->gen_vector_hash(previously fetched sticker IDs) | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v75/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v75/methods/messages_getUnreadMentions.md index 88e895e4..9b221db9 100644 --- a/old_docs/API_docs_v75/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v75/methods/messages_getUnreadMentions.md @@ -11,14 +11,14 @@ Get unread mentions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[int](../types/int.md) | Yes|The offset| -|add\_offset|[int](../types/int.md) | Yes|The additional offset| -|limit|[int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to get unread mentions | Optional| +|offset\_id|[int](../types/int.md) | The offset | Yes| +|add\_offset|[int](../types/int.md) | The additional offset | Yes| +|limit|[int](../types/int.md) | The number of results to fetch | Yes| +|max\_id|[int](../types/int.md) | The maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | The minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v75/methods/messages_getWebPage.md b/old_docs/API_docs_v75/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v75/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v75/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v75/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v75/methods/messages_getWebPagePreview.md index 21652a7b..99ef2e5a 100644 --- a/old_docs/API_docs_v75/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v75/methods/messages_getWebPagePreview.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v75/methods/messages_hideReportSpam.md b/old_docs/API_docs_v75/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v75/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v75/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_importChatInvite.md b/old_docs/API_docs_v75/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v75/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v75/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_installStickerSet.md b/old_docs/API_docs_v75/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v75/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v75/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v75/methods/messages_migrateChat.md b/old_docs/API_docs_v75/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v75/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v75/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v75/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v75/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v75/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v75/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v75/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v75/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_readHistory.md b/old_docs/API_docs_v75/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v75/methods/messages_readHistory.md +++ b/old_docs/API_docs_v75/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v75/methods/messages_readMentions.md b/old_docs/API_docs_v75/methods/messages_readMentions.md index c58cb06a..31874ee6 100644 --- a/old_docs/API_docs_v75/methods/messages_readMentions.md +++ b/old_docs/API_docs_v75/methods/messages_readMentions.md @@ -11,9 +11,9 @@ Mark mentions as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v75/methods/messages_readMessageContents.md b/old_docs/API_docs_v75/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v75/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v75/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v75/methods/messages_receivedMessages.md b/old_docs/API_docs_v75/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v75/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v75/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v75/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v75/methods/messages_reorderPinnedDialogs.md index 8f42ca70..4d2cb53e 100644 --- a/old_docs/API_docs_v75/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v75/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v75/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v75/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v75/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v75/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v75/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v75/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_reportSpam.md b/old_docs/API_docs_v75/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v75/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v75/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_saveDraft.md b/old_docs/API_docs_v75/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v75/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v75/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v75/methods/messages_saveGif.md b/old_docs/API_docs_v75/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v75/methods/messages_saveGif.md +++ b/old_docs/API_docs_v75/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v75/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v75/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v75/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_search.md b/old_docs/API_docs_v75/methods/messages_search.md index a0907b88..159f893b 100644 --- a/old_docs/API_docs_v75/methods/messages_search.md +++ b/old_docs/API_docs_v75/methods/messages_search.md @@ -11,19 +11,19 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|min\_id|[int](../types/int.md) | Minumum message id to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v75/methods/messages_searchGifs.md b/old_docs/API_docs_v75/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v75/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v75/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v75/methods/messages_searchGlobal.md b/old_docs/API_docs_v75/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v75/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v75/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v75/methods/messages_sendEncrypted.md b/old_docs/API_docs_v75/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v75/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v75/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v75/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v75/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v75/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v75/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v75/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v75/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v75/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v75/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v75/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v75/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v75/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v75/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_sendMedia.md b/old_docs/API_docs_v75/methods/messages_sendMedia.md index a795c5d1..738c6df9 100644 --- a/old_docs/API_docs_v75/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v75/methods/messages_sendMedia.md @@ -11,17 +11,17 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|message|[string](../types/string.md) | Yes|The caption| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|message|[string](../types/string.md) | The caption | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -127,6 +127,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http: |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v75/methods/messages_sendMessage.md b/old_docs/API_docs_v75/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v75/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v75/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v75/methods/messages_sendMultiMedia.md b/old_docs/API_docs_v75/methods/messages_sendMultiMedia.md index 92baa8ab..115d2f60 100644 --- a/old_docs/API_docs_v75/methods/messages_sendMultiMedia.md +++ b/old_docs/API_docs_v75/methods/messages_sendMultiMedia.md @@ -11,14 +11,14 @@ Send an album ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notification? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the album | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | The album | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v75/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/old_docs/API_docs_v75/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v75/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v75/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v75/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v75/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v75/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v75/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v75/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v75/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v75/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v75/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v75/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v75/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v75/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_setGameScore.md b/old_docs/API_docs_v75/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v75/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v75/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v75/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v75/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v75/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v75/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v75/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v75/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_setTyping.md b/old_docs/API_docs_v75/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v75/methods/messages_setTyping.md +++ b/old_docs/API_docs_v75/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_startBot.md b/old_docs/API_docs_v75/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v75/methods/messages_startBot.md +++ b/old_docs/API_docs_v75/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v75/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v75/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v75/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v75/methods/messages_toggleDialogPin.md index 9be679e2..57f673a0 100644 --- a/old_docs/API_docs_v75/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v75/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to pin | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v75/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v75/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v75/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/messages_uploadEncryptedFile.md b/old_docs/API_docs_v75/methods/messages_uploadEncryptedFile.md index abb08479..91159bb5 100644 --- a/old_docs/API_docs_v75/methods/messages_uploadEncryptedFile.md +++ b/old_docs/API_docs_v75/methods/messages_uploadEncryptedFile.md @@ -11,10 +11,10 @@ Upload a secret chat file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to upload the media| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to upload the media | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file | Optional| ### Return type: [EncryptedFile](../types/EncryptedFile.md) diff --git a/old_docs/API_docs_v75/methods/messages_uploadMedia.md b/old_docs/API_docs_v75/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v75/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v75/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v75/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v75/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v75/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v75/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/payments_getPaymentForm.md b/old_docs/API_docs_v75/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v75/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v75/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v75/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v75/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v75/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v75/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v75/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v75/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v75/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v75/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v75/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v75/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v75/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v75/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v75/methods/phone_receivedCall.md b/old_docs/API_docs_v75/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v75/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v75/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/phone_saveCallDebug.md b/old_docs/API_docs_v75/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v75/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v75/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v75/methods/phone_setCallRating.md b/old_docs/API_docs_v75/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v75/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v75/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v75/methods/photos_deletePhotos.md b/old_docs/API_docs_v75/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v75/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v75/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v75/methods/photos_getUserPhotos.md b/old_docs/API_docs_v75/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v75/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v75/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v75/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v75/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v75/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v75/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v75/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v75/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v75/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v75/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v75/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v75/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v75/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v75/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v75/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v75/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/old_docs/API_docs_v75/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v75/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v75/methods/stickers_createStickerSet.md b/old_docs/API_docs_v75/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v75/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v75/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v75/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v75/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/old_docs/API_docs_v75/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v75/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v75/methods/upload_getWebFile.md b/old_docs/API_docs_v75/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v75/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v75/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v75/methods/users_getUsers.md b/old_docs/API_docs_v75/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v75/methods/users_getUsers.md +++ b/old_docs/API_docs_v75/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v81/methods/account_acceptAuthorization.md b/old_docs/API_docs_v81/methods/account_acceptAuthorization.md index b92ec185..48cafe8a 100644 --- a/old_docs/API_docs_v81/methods/account_acceptAuthorization.md +++ b/old_docs/API_docs_v81/methods/account_acceptAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_changePhone.md b/old_docs/API_docs_v81/methods/account_changePhone.md index 776e45cc..d5c878dc 100644 --- a/old_docs/API_docs_v81/methods/account_changePhone.md +++ b/old_docs/API_docs_v81/methods/account_changePhone.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_checkUsername.md b/old_docs/API_docs_v81/methods/account_checkUsername.md index 621f3a4e..e252a329 100644 --- a/old_docs/API_docs_v81/methods/account_checkUsername.md +++ b/old_docs/API_docs_v81/methods/account_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_confirmPhone.md b/old_docs/API_docs_v81/methods/account_confirmPhone.md index 676881f2..a42b69b7 100644 --- a/old_docs/API_docs_v81/methods/account_confirmPhone.md +++ b/old_docs/API_docs_v81/methods/account_confirmPhone.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_deleteAccount.md b/old_docs/API_docs_v81/methods/account_deleteAccount.md index 8c107f8a..7c66c38a 100644 --- a/old_docs/API_docs_v81/methods/account_deleteAccount.md +++ b/old_docs/API_docs_v81/methods/account_deleteAccount.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_deleteSecureValue.md b/old_docs/API_docs_v81/methods/account_deleteSecureValue.md index b8e1c613..cfb5bdf1 100644 --- a/old_docs/API_docs_v81/methods/account_deleteSecureValue.md +++ b/old_docs/API_docs_v81/methods/account_deleteSecureValue.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md b/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md index f858b3d8..6b21cbef 100644 --- a/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md +++ b/old_docs/API_docs_v81/methods/account_finishTakeoutSession.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md b/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md index e3353093..ae177a4a 100644 --- a/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md +++ b/old_docs/API_docs_v81/methods/account_getAuthorizationForm.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_getNotifySettings.md b/old_docs/API_docs_v81/methods/account_getNotifySettings.md index 3b4cc70d..f4e09b3c 100644 --- a/old_docs/API_docs_v81/methods/account_getNotifySettings.md +++ b/old_docs/API_docs_v81/methods/account_getNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_getPasswordSettings.md b/old_docs/API_docs_v81/methods/account_getPasswordSettings.md index cc3bc1ec..d6c12a02 100644 --- a/old_docs/API_docs_v81/methods/account_getPasswordSettings.md +++ b/old_docs/API_docs_v81/methods/account_getPasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_getPrivacy.md b/old_docs/API_docs_v81/methods/account_getPrivacy.md index 739a104b..f4a953ac 100644 --- a/old_docs/API_docs_v81/methods/account_getPrivacy.md +++ b/old_docs/API_docs_v81/methods/account_getPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_getSecureValue.md b/old_docs/API_docs_v81/methods/account_getSecureValue.md index 9aa09313..d62988b4 100644 --- a/old_docs/API_docs_v81/methods/account_getSecureValue.md +++ b/old_docs/API_docs_v81/methods/account_getSecureValue.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_getTmpPassword.md b/old_docs/API_docs_v81/methods/account_getTmpPassword.md index f12a6bb1..504fbbc3 100644 --- a/old_docs/API_docs_v81/methods/account_getTmpPassword.md +++ b/old_docs/API_docs_v81/methods/account_getTmpPassword.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_initTakeoutSession.md b/old_docs/API_docs_v81/methods/account_initTakeoutSession.md index d11c9075..68fc8ab3 100644 --- a/old_docs/API_docs_v81/methods/account_initTakeoutSession.md +++ b/old_docs/API_docs_v81/methods/account_initTakeoutSession.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_registerDevice.md b/old_docs/API_docs_v81/methods/account_registerDevice.md index 812f5e44..a1256cd1 100644 --- a/old_docs/API_docs_v81/methods/account_registerDevice.md +++ b/old_docs/API_docs_v81/methods/account_registerDevice.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_reportPeer.md b/old_docs/API_docs_v81/methods/account_reportPeer.md index bec1a8da..d8c49851 100644 --- a/old_docs/API_docs_v81/methods/account_reportPeer.md +++ b/old_docs/API_docs_v81/methods/account_reportPeer.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_resetAuthorization.md b/old_docs/API_docs_v81/methods/account_resetAuthorization.md index 8a555666..678e6f31 100644 --- a/old_docs/API_docs_v81/methods/account_resetAuthorization.md +++ b/old_docs/API_docs_v81/methods/account_resetAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md b/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md index 9d42f177..2d987787 100644 --- a/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md +++ b/old_docs/API_docs_v81/methods/account_resetWebAuthorization.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_saveSecureValue.md b/old_docs/API_docs_v81/methods/account_saveSecureValue.md index beb39134..a54d1783 100644 --- a/old_docs/API_docs_v81/methods/account_saveSecureValue.md +++ b/old_docs/API_docs_v81/methods/account_saveSecureValue.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md b/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md index ac288314..33a001b9 100644 --- a/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md +++ b/old_docs/API_docs_v81/methods/account_sendChangePhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md b/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md index 14dbd095..a70ad5a3 100644 --- a/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md +++ b/old_docs/API_docs_v81/methods/account_sendConfirmPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md b/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md index c513c310..712018bd 100644 --- a/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md +++ b/old_docs/API_docs_v81/methods/account_sendVerifyEmailCode.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md b/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md index 4420d730..ea7e6c10 100644 --- a/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md +++ b/old_docs/API_docs_v81/methods/account_sendVerifyPhoneCode.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_setAccountTTL.md b/old_docs/API_docs_v81/methods/account_setAccountTTL.md index de5304fc..ff37ea70 100644 --- a/old_docs/API_docs_v81/methods/account_setAccountTTL.md +++ b/old_docs/API_docs_v81/methods/account_setAccountTTL.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_setPrivacy.md b/old_docs/API_docs_v81/methods/account_setPrivacy.md index 7ccb4c2e..7dac79b9 100644 --- a/old_docs/API_docs_v81/methods/account_setPrivacy.md +++ b/old_docs/API_docs_v81/methods/account_setPrivacy.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_unregisterDevice.md b/old_docs/API_docs_v81/methods/account_unregisterDevice.md index 5da8c776..b20ec9f0 100644 --- a/old_docs/API_docs_v81/methods/account_unregisterDevice.md +++ b/old_docs/API_docs_v81/methods/account_unregisterDevice.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md b/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md index f6a68825..a21aa6c2 100644 --- a/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md +++ b/old_docs/API_docs_v81/methods/account_updateDeviceLocked.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_updateNotifySettings.md b/old_docs/API_docs_v81/methods/account_updateNotifySettings.md index bc48835f..6549ebea 100644 --- a/old_docs/API_docs_v81/methods/account_updateNotifySettings.md +++ b/old_docs/API_docs_v81/methods/account_updateNotifySettings.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md b/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md index 2ae21011..043fdb45 100644 --- a/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md +++ b/old_docs/API_docs_v81/methods/account_updatePasswordSettings.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_updateProfile.md b/old_docs/API_docs_v81/methods/account_updateProfile.md index 1ba4d059..f415381f 100644 --- a/old_docs/API_docs_v81/methods/account_updateProfile.md +++ b/old_docs/API_docs_v81/methods/account_updateProfile.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_updateStatus.md b/old_docs/API_docs_v81/methods/account_updateStatus.md index b5e5b531..2fded2ce 100644 --- a/old_docs/API_docs_v81/methods/account_updateStatus.md +++ b/old_docs/API_docs_v81/methods/account_updateStatus.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_updateUsername.md b/old_docs/API_docs_v81/methods/account_updateUsername.md index 1215b66f..d1622d9f 100644 --- a/old_docs/API_docs_v81/methods/account_updateUsername.md +++ b/old_docs/API_docs_v81/methods/account_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_verifyEmail.md b/old_docs/API_docs_v81/methods/account_verifyEmail.md index ee14f51b..4cfc82aa 100644 --- a/old_docs/API_docs_v81/methods/account_verifyEmail.md +++ b/old_docs/API_docs_v81/methods/account_verifyEmail.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/account_verifyPhone.md b/old_docs/API_docs_v81/methods/account_verifyPhone.md index 667416e7..075ab95b 100644 --- a/old_docs/API_docs_v81/methods/account_verifyPhone.md +++ b/old_docs/API_docs_v81/methods/account_verifyPhone.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/auth_cancelCode.md b/old_docs/API_docs_v81/methods/auth_cancelCode.md index 4657ed9c..0b53954c 100644 --- a/old_docs/API_docs_v81/methods/auth_cancelCode.md +++ b/old_docs/API_docs_v81/methods/auth_cancelCode.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md b/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md index 27d9f71e..26d63e12 100644 --- a/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md +++ b/old_docs/API_docs_v81/methods/auth_dropTempAuthKeys.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/auth_recoverPassword.md b/old_docs/API_docs_v81/methods/auth_recoverPassword.md index 1b46477a..f7e82e38 100644 --- a/old_docs/API_docs_v81/methods/auth_recoverPassword.md +++ b/old_docs/API_docs_v81/methods/auth_recoverPassword.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/auth_resendCode.md b/old_docs/API_docs_v81/methods/auth_resendCode.md index e433903c..28350d37 100644 --- a/old_docs/API_docs_v81/methods/auth_resendCode.md +++ b/old_docs/API_docs_v81/methods/auth_resendCode.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md b/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md index 7f68abb3..6ed252ff 100644 --- a/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md +++ b/old_docs/API_docs_v81/methods/bots_answerWebhookJSONQuery.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md b/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md index c6c5fbfd..d14215ec 100644 --- a/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md +++ b/old_docs/API_docs_v81/methods/bots_sendCustomRequest.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_checkUsername.md b/old_docs/API_docs_v81/methods/channels_checkUsername.md index aaca17ac..d287b3ca 100644 --- a/old_docs/API_docs_v81/methods/channels_checkUsername.md +++ b/old_docs/API_docs_v81/methods/channels_checkUsername.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_createChannel.md b/old_docs/API_docs_v81/methods/channels_createChannel.md index 2d6912ab..356f473a 100644 --- a/old_docs/API_docs_v81/methods/channels_createChannel.md +++ b/old_docs/API_docs_v81/methods/channels_createChannel.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_deleteChannel.md b/old_docs/API_docs_v81/methods/channels_deleteChannel.md index 13c5309b..b55d91b8 100644 --- a/old_docs/API_docs_v81/methods/channels_deleteChannel.md +++ b/old_docs/API_docs_v81/methods/channels_deleteChannel.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_deleteHistory.md b/old_docs/API_docs_v81/methods/channels_deleteHistory.md index d33bdbe0..ea331b8b 100644 --- a/old_docs/API_docs_v81/methods/channels_deleteHistory.md +++ b/old_docs/API_docs_v81/methods/channels_deleteHistory.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_deleteMessages.md b/old_docs/API_docs_v81/methods/channels_deleteMessages.md index d21abe4f..03625c94 100644 --- a/old_docs/API_docs_v81/methods/channels_deleteMessages.md +++ b/old_docs/API_docs_v81/methods/channels_deleteMessages.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md b/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md index a499769c..204a8786 100644 --- a/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md +++ b/old_docs/API_docs_v81/methods/channels_deleteUserHistory.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_editAbout.md b/old_docs/API_docs_v81/methods/channels_editAbout.md index d4068411..fd861133 100644 --- a/old_docs/API_docs_v81/methods/channels_editAbout.md +++ b/old_docs/API_docs_v81/methods/channels_editAbout.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_editAdmin.md b/old_docs/API_docs_v81/methods/channels_editAdmin.md index 6a767f36..08860c79 100644 --- a/old_docs/API_docs_v81/methods/channels_editAdmin.md +++ b/old_docs/API_docs_v81/methods/channels_editAdmin.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_editBanned.md b/old_docs/API_docs_v81/methods/channels_editBanned.md index fe7d026c..e938acc0 100644 --- a/old_docs/API_docs_v81/methods/channels_editBanned.md +++ b/old_docs/API_docs_v81/methods/channels_editBanned.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_editPhoto.md b/old_docs/API_docs_v81/methods/channels_editPhoto.md index fa88f9ef..ccbaed65 100644 --- a/old_docs/API_docs_v81/methods/channels_editPhoto.md +++ b/old_docs/API_docs_v81/methods/channels_editPhoto.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_editTitle.md b/old_docs/API_docs_v81/methods/channels_editTitle.md index 518fc158..ffd868ba 100644 --- a/old_docs/API_docs_v81/methods/channels_editTitle.md +++ b/old_docs/API_docs_v81/methods/channels_editTitle.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_exportInvite.md b/old_docs/API_docs_v81/methods/channels_exportInvite.md index aa6e54e0..0b4b5c31 100644 --- a/old_docs/API_docs_v81/methods/channels_exportInvite.md +++ b/old_docs/API_docs_v81/methods/channels_exportInvite.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_exportMessageLink.md b/old_docs/API_docs_v81/methods/channels_exportMessageLink.md index 595e4b70..3b6e7e9e 100644 --- a/old_docs/API_docs_v81/methods/channels_exportMessageLink.md +++ b/old_docs/API_docs_v81/methods/channels_exportMessageLink.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_getAdminLog.md b/old_docs/API_docs_v81/methods/channels_getAdminLog.md index f78919bb..266c07d7 100644 --- a/old_docs/API_docs_v81/methods/channels_getAdminLog.md +++ b/old_docs/API_docs_v81/methods/channels_getAdminLog.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_getChannels.md b/old_docs/API_docs_v81/methods/channels_getChannels.md index 990e6071..71edac7b 100644 --- a/old_docs/API_docs_v81/methods/channels_getChannels.md +++ b/old_docs/API_docs_v81/methods/channels_getChannels.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_getLeftChannels.md b/old_docs/API_docs_v81/methods/channels_getLeftChannels.md index b51c86d9..cf06518b 100644 --- a/old_docs/API_docs_v81/methods/channels_getLeftChannels.md +++ b/old_docs/API_docs_v81/methods/channels_getLeftChannels.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_getMessages.md b/old_docs/API_docs_v81/methods/channels_getMessages.md index 2c2d822a..4f63c3a2 100644 --- a/old_docs/API_docs_v81/methods/channels_getMessages.md +++ b/old_docs/API_docs_v81/methods/channels_getMessages.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_getParticipant.md b/old_docs/API_docs_v81/methods/channels_getParticipant.md index 4163e345..a641d213 100644 --- a/old_docs/API_docs_v81/methods/channels_getParticipant.md +++ b/old_docs/API_docs_v81/methods/channels_getParticipant.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_getParticipants.md b/old_docs/API_docs_v81/methods/channels_getParticipants.md index 00446bf1..0ab83257 100644 --- a/old_docs/API_docs_v81/methods/channels_getParticipants.md +++ b/old_docs/API_docs_v81/methods/channels_getParticipants.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_inviteToChannel.md b/old_docs/API_docs_v81/methods/channels_inviteToChannel.md index e42f9554..0a350cc8 100644 --- a/old_docs/API_docs_v81/methods/channels_inviteToChannel.md +++ b/old_docs/API_docs_v81/methods/channels_inviteToChannel.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_joinChannel.md b/old_docs/API_docs_v81/methods/channels_joinChannel.md index 2d6a208b..aae2bc1c 100644 --- a/old_docs/API_docs_v81/methods/channels_joinChannel.md +++ b/old_docs/API_docs_v81/methods/channels_joinChannel.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_leaveChannel.md b/old_docs/API_docs_v81/methods/channels_leaveChannel.md index 0ceb07f1..4e6701fe 100644 --- a/old_docs/API_docs_v81/methods/channels_leaveChannel.md +++ b/old_docs/API_docs_v81/methods/channels_leaveChannel.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_readHistory.md b/old_docs/API_docs_v81/methods/channels_readHistory.md index c0836633..d76919ff 100644 --- a/old_docs/API_docs_v81/methods/channels_readHistory.md +++ b/old_docs/API_docs_v81/methods/channels_readHistory.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_readMessageContents.md b/old_docs/API_docs_v81/methods/channels_readMessageContents.md index f0addc30..51fffda5 100644 --- a/old_docs/API_docs_v81/methods/channels_readMessageContents.md +++ b/old_docs/API_docs_v81/methods/channels_readMessageContents.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_reportSpam.md b/old_docs/API_docs_v81/methods/channels_reportSpam.md index c9991738..48022662 100644 --- a/old_docs/API_docs_v81/methods/channels_reportSpam.md +++ b/old_docs/API_docs_v81/methods/channels_reportSpam.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_setStickers.md b/old_docs/API_docs_v81/methods/channels_setStickers.md index 8557a723..421b3ec1 100644 --- a/old_docs/API_docs_v81/methods/channels_setStickers.md +++ b/old_docs/API_docs_v81/methods/channels_setStickers.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_toggleInvites.md b/old_docs/API_docs_v81/methods/channels_toggleInvites.md index 6dd85f57..d0023b70 100644 --- a/old_docs/API_docs_v81/methods/channels_toggleInvites.md +++ b/old_docs/API_docs_v81/methods/channels_toggleInvites.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md b/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md index cc48c100..c25f6358 100644 --- a/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md +++ b/old_docs/API_docs_v81/methods/channels_togglePreHistoryHidden.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_toggleSignatures.md b/old_docs/API_docs_v81/methods/channels_toggleSignatures.md index 55847101..337e8627 100644 --- a/old_docs/API_docs_v81/methods/channels_toggleSignatures.md +++ b/old_docs/API_docs_v81/methods/channels_toggleSignatures.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md b/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md index 7ea94b5b..c79c5904 100644 --- a/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md +++ b/old_docs/API_docs_v81/methods/channels_updatePinnedMessage.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/channels_updateUsername.md b/old_docs/API_docs_v81/methods/channels_updateUsername.md index 8bd0b5b8..2e07e123 100644 --- a/old_docs/API_docs_v81/methods/channels_updateUsername.md +++ b/old_docs/API_docs_v81/methods/channels_updateUsername.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_block.md b/old_docs/API_docs_v81/methods/contacts_block.md index ec9366c2..aae07768 100644 --- a/old_docs/API_docs_v81/methods/contacts_block.md +++ b/old_docs/API_docs_v81/methods/contacts_block.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_deleteContact.md b/old_docs/API_docs_v81/methods/contacts_deleteContact.md index 9269c8e2..f8aa2a4b 100644 --- a/old_docs/API_docs_v81/methods/contacts_deleteContact.md +++ b/old_docs/API_docs_v81/methods/contacts_deleteContact.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_deleteContacts.md b/old_docs/API_docs_v81/methods/contacts_deleteContacts.md index 29883884..46c6e5af 100644 --- a/old_docs/API_docs_v81/methods/contacts_deleteContacts.md +++ b/old_docs/API_docs_v81/methods/contacts_deleteContacts.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_getBlocked.md b/old_docs/API_docs_v81/methods/contacts_getBlocked.md index da656170..76156caf 100644 --- a/old_docs/API_docs_v81/methods/contacts_getBlocked.md +++ b/old_docs/API_docs_v81/methods/contacts_getBlocked.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_getContacts.md b/old_docs/API_docs_v81/methods/contacts_getContacts.md index 58c49847..48634fbb 100644 --- a/old_docs/API_docs_v81/methods/contacts_getContacts.md +++ b/old_docs/API_docs_v81/methods/contacts_getContacts.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_getTopPeers.md b/old_docs/API_docs_v81/methods/contacts_getTopPeers.md index ef5f40a7..82a0c794 100644 --- a/old_docs/API_docs_v81/methods/contacts_getTopPeers.md +++ b/old_docs/API_docs_v81/methods/contacts_getTopPeers.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_importCard.md b/old_docs/API_docs_v81/methods/contacts_importCard.md index 080371ae..48949aa8 100644 --- a/old_docs/API_docs_v81/methods/contacts_importCard.md +++ b/old_docs/API_docs_v81/methods/contacts_importCard.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_importContacts.md b/old_docs/API_docs_v81/methods/contacts_importContacts.md index 6aee0ac0..eddbe116 100644 --- a/old_docs/API_docs_v81/methods/contacts_importContacts.md +++ b/old_docs/API_docs_v81/methods/contacts_importContacts.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md b/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md index c232f7cc..96ae48ac 100644 --- a/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md +++ b/old_docs/API_docs_v81/methods/contacts_resetTopPeerRating.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_search.md b/old_docs/API_docs_v81/methods/contacts_search.md index c3e55d7d..a80e2a27 100644 --- a/old_docs/API_docs_v81/methods/contacts_search.md +++ b/old_docs/API_docs_v81/methods/contacts_search.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/contacts_unblock.md b/old_docs/API_docs_v81/methods/contacts_unblock.md index 7654feb0..e3c68b8d 100644 --- a/old_docs/API_docs_v81/methods/contacts_unblock.md +++ b/old_docs/API_docs_v81/methods/contacts_unblock.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md b/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md index 54f78d58..9d9a5f89 100644 --- a/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md +++ b/old_docs/API_docs_v81/methods/help_acceptTermsOfService.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/help_getAppChangelog.md b/old_docs/API_docs_v81/methods/help_getAppChangelog.md index 6513df19..10b972c1 100644 --- a/old_docs/API_docs_v81/methods/help_getAppChangelog.md +++ b/old_docs/API_docs_v81/methods/help_getAppChangelog.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md b/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md index 3bba16de..9e816258 100644 --- a/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md +++ b/old_docs/API_docs_v81/methods/help_getDeepLinkInfo.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md b/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md index 5043cc42..27a451bb 100644 --- a/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md +++ b/old_docs/API_docs_v81/methods/help_getRecentMeUrls.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/help_saveAppLog.md b/old_docs/API_docs_v81/methods/help_saveAppLog.md index 9acd6174..bbc0cc39 100644 --- a/old_docs/API_docs_v81/methods/help_saveAppLog.md +++ b/old_docs/API_docs_v81/methods/help_saveAppLog.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md b/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md index be3c0ead..0429f8a0 100644 --- a/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md +++ b/old_docs/API_docs_v81/methods/help_setBotUpdatesStatus.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/initConnection.md b/old_docs/API_docs_v81/methods/initConnection.md index eb1b522e..71d71bb8 100644 --- a/old_docs/API_docs_v81/methods/initConnection.md +++ b/old_docs/API_docs_v81/methods/initConnection.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/invokeAfterMsg.md b/old_docs/API_docs_v81/methods/invokeAfterMsg.md index 41a381dc..cc724753 100644 --- a/old_docs/API_docs_v81/methods/invokeAfterMsg.md +++ b/old_docs/API_docs_v81/methods/invokeAfterMsg.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/invokeAfterMsgs.md b/old_docs/API_docs_v81/methods/invokeAfterMsgs.md index 413fc752..16eec772 100644 --- a/old_docs/API_docs_v81/methods/invokeAfterMsgs.md +++ b/old_docs/API_docs_v81/methods/invokeAfterMsgs.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/invokeWithLayer.md b/old_docs/API_docs_v81/methods/invokeWithLayer.md index b95ce2eb..923b17d1 100644 --- a/old_docs/API_docs_v81/methods/invokeWithLayer.md +++ b/old_docs/API_docs_v81/methods/invokeWithLayer.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md b/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md index cdf2dae3..24e87100 100644 --- a/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md +++ b/old_docs/API_docs_v81/methods/invokeWithMessagesRange.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/invokeWithTakeout.md b/old_docs/API_docs_v81/methods/invokeWithTakeout.md index a51e1690..aa6683a4 100644 --- a/old_docs/API_docs_v81/methods/invokeWithTakeout.md +++ b/old_docs/API_docs_v81/methods/invokeWithTakeout.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md b/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md index 61e02226..b696672a 100644 --- a/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md +++ b/old_docs/API_docs_v81/methods/invokeWithoutUpdates.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/langpack_getDifference.md b/old_docs/API_docs_v81/methods/langpack_getDifference.md index 26b783c8..0614d869 100644 --- a/old_docs/API_docs_v81/methods/langpack_getDifference.md +++ b/old_docs/API_docs_v81/methods/langpack_getDifference.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/langpack_getLangPack.md b/old_docs/API_docs_v81/methods/langpack_getLangPack.md index 731998ba..70f9eb73 100644 --- a/old_docs/API_docs_v81/methods/langpack_getLangPack.md +++ b/old_docs/API_docs_v81/methods/langpack_getLangPack.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/langpack_getStrings.md b/old_docs/API_docs_v81/methods/langpack_getStrings.md index fd5ff929..3042b040 100644 --- a/old_docs/API_docs_v81/methods/langpack_getStrings.md +++ b/old_docs/API_docs_v81/methods/langpack_getStrings.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/messages_addChatUser.md b/old_docs/API_docs_v81/methods/messages_addChatUser.md index d79a1d45..5d98e17c 100644 --- a/old_docs/API_docs_v81/methods/messages_addChatUser.md +++ b/old_docs/API_docs_v81/methods/messages_addChatUser.md @@ -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) diff --git a/old_docs/API_docs_v81/methods/messages_checkChatInvite.md b/old_docs/API_docs_v81/methods/messages_checkChatInvite.md index f82a427e..1f41d33a 100644 --- a/old_docs/API_docs_v81/methods/messages_checkChatInvite.md +++ b/old_docs/API_docs_v81/methods/messages_checkChatInvite.md @@ -11,9 +11,9 @@ Check if an invitation link is valid ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [ChatInvite](../types/ChatInvite.md) diff --git a/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md b/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md index b5087461..56634143 100644 --- a/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md +++ b/old_docs/API_docs_v81/methods/messages_clearRecentStickers.md @@ -11,9 +11,9 @@ Clear all recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Clear recent stickers attached to images?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Clear recent stickers attached to images? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_createChat.md b/old_docs/API_docs_v81/methods/messages_createChat.md index 931dce58..60d9bbd9 100644 --- a/old_docs/API_docs_v81/methods/messages_createChat.md +++ b/old_docs/API_docs_v81/methods/messages_createChat.md @@ -11,10 +11,10 @@ Create a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to add to the chat| -|title|[string](../types/string.md) | Yes|The new chat's title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|users|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to add to the chat | Yes| +|title|[string](../types/string.md) | The new chat's title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_deleteChatUser.md b/old_docs/API_docs_v81/methods/messages_deleteChatUser.md index e0ab29a9..0c7f6223 100644 --- a/old_docs/API_docs_v81/methods/messages_deleteChatUser.md +++ b/old_docs/API_docs_v81/methods/messages_deleteChatUser.md @@ -11,10 +11,10 @@ Delete a user from a chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user to delete (pass @me to leave the chat)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user to delete (pass @me to leave the chat) | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_deleteHistory.md b/old_docs/API_docs_v81/methods/messages_deleteHistory.md index 8878ffbf..866ba216 100644 --- a/old_docs/API_docs_v81/methods/messages_deleteHistory.md +++ b/old_docs/API_docs_v81/methods/messages_deleteHistory.md @@ -11,11 +11,11 @@ Delete chat history ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|just\_clear|[Bool](../types/Bool.md) | Optional|Only clear it from your side| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to clear it| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|just\_clear|[Bool](../types/Bool.md) | Only clear it from your side | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to clear it | Optional| +|max\_id|[int](../types/int.md) | Maximum message id of messages to delete | Yes| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v81/methods/messages_deleteMessages.md b/old_docs/API_docs_v81/methods/messages_deleteMessages.md index 67a321f9..eaf9cd86 100644 --- a/old_docs/API_docs_v81/methods/messages_deleteMessages.md +++ b/old_docs/API_docs_v81/methods/messages_deleteMessages.md @@ -11,10 +11,10 @@ Delete messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|revoke|[Bool](../types/Bool.md) | Optional|Delete the messages for everyone?| -|id|Array of [int](../types/int.md) | Yes|IDs of messages to delete, use channels->deleteMessages for supergroups| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|revoke|[Bool](../types/Bool.md) | Delete the messages for everyone? | Optional| +|id|Array of [int](../types/int.md) | IDs of messages to delete, use channels->deleteMessages for supergroups | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v81/methods/messages_editChatAdmin.md b/old_docs/API_docs_v81/methods/messages_editChatAdmin.md index bebfd4b5..a2dad97f 100644 --- a/old_docs/API_docs_v81/methods/messages_editChatAdmin.md +++ b/old_docs/API_docs_v81/methods/messages_editChatAdmin.md @@ -11,11 +11,11 @@ Edit admin permissions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat ID (no supergroups)| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|is\_admin|[Bool](../types/Bool.md) | Yes|Should the user be admin?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat ID (no supergroups) | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|is\_admin|[Bool](../types/Bool.md) | Should the user be admin? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_editChatPhoto.md b/old_docs/API_docs_v81/methods/messages_editChatPhoto.md index 55d3da32..77246643 100644 --- a/old_docs/API_docs_v81/methods/messages_editChatPhoto.md +++ b/old_docs/API_docs_v81/methods/messages_editChatPhoto.md @@ -11,10 +11,10 @@ Edit the photo of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|photo|[InputChatPhoto](../types/InputChatPhoto.md) | Optional|The new phto| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|photo|[InputChatPhoto](../types/InputChatPhoto.md) | The new phto | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_editChatTitle.md b/old_docs/API_docs_v81/methods/messages_editChatTitle.md index 8c412d48..ffff7fc8 100644 --- a/old_docs/API_docs_v81/methods/messages_editChatTitle.md +++ b/old_docs/API_docs_v81/methods/messages_editChatTitle.md @@ -11,10 +11,10 @@ Edit the title of a normal chat (not supergroup) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The ID of the chat| -|title|[string](../types/string.md) | Yes|The new title| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The ID of the chat | Optional| +|title|[string](../types/string.md) | The new title | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md b/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md index 4d097f4c..ec4620f4 100644 --- a/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md +++ b/old_docs/API_docs_v81/methods/messages_editInlineBotMessage.md @@ -11,17 +11,17 @@ Edit a sent inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to substitute| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to substitute | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_editMessage.md b/old_docs/API_docs_v81/methods/messages_editMessage.md index f5a5b5c1..4bceb2aa 100644 --- a/old_docs/API_docs_v81/methods/messages_editMessage.md +++ b/old_docs/API_docs_v81/methods/messages_editMessage.md @@ -11,18 +11,18 @@ Edit a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|stop\_geo\_live|[Bool](../types/Bool.md) | Optional|Stop live location| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|message|[string](../types/string.md) | Optional|The new message| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to substitute| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|The new keyboard| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The new entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|stop\_geo\_live|[Bool](../types/Bool.md) | Stop live location | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|message|[string](../types/string.md) | The new message | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to substitute | Optional| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | The new keyboard | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The new entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The new location| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The new location | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_exportChatInvite.md b/old_docs/API_docs_v81/methods/messages_exportChatInvite.md index 8c0955fa..dde31bc9 100644 --- a/old_docs/API_docs_v81/methods/messages_exportChatInvite.md +++ b/old_docs/API_docs_v81/methods/messages_exportChatInvite.md @@ -11,9 +11,9 @@ Export chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat id | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat id | Optional| ### Return type: [ExportedChatInvite](../types/ExportedChatInvite.md) diff --git a/old_docs/API_docs_v81/methods/messages_faveSticker.md b/old_docs/API_docs_v81/methods/messages_faveSticker.md index 05c04983..302957c5 100644 --- a/old_docs/API_docs_v81/methods/messages_faveSticker.md +++ b/old_docs/API_docs_v81/methods/messages_faveSticker.md @@ -11,10 +11,10 @@ Add a sticker to favorites ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to add to favorites| -|unfave|[Bool](../types/Bool.md) | Yes|Remove it from favorites?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to add to favorites | Optional| +|unfave|[Bool](../types/Bool.md) | Remove it from favorites? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_forwardMessages.md b/old_docs/API_docs_v81/methods/messages_forwardMessages.md index e0091c2e..3372333c 100644 --- a/old_docs/API_docs_v81/methods/messages_forwardMessages.md +++ b/old_docs/API_docs_v81/methods/messages_forwardMessages.md @@ -11,15 +11,15 @@ Forward messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications| -|with\_my\_score|[Bool](../types/Bool.md) | Optional|If forwarding a game, forward your score, too| -|grouped|[Bool](../types/Bool.md) | Optional|Set to true if forwarding albums| -|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|From where to forward the messages| -|id|Array of [int](../types/int.md) | Yes|The message IDs| -|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to forward the messages| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications | Optional| +|with\_my\_score|[Bool](../types/Bool.md) | If forwarding a game, forward your score, too | Optional| +|grouped|[Bool](../types/Bool.md) | Set to true if forwarding albums | Optional| +|from\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | From where to forward the messages | Optional| +|id|Array of [int](../types/int.md) | The message IDs | Yes| +|to\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to forward the messages | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_getAllChats.md b/old_docs/API_docs_v81/methods/messages_getAllChats.md index 862a1694..663af07c 100644 --- a/old_docs/API_docs_v81/methods/messages_getAllChats.md +++ b/old_docs/API_docs_v81/methods/messages_getAllChats.md @@ -11,9 +11,9 @@ Get all chats (not supergroups or channels) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|except\_ids|Array of [int](../types/int.md) | Yes|Do not fetch these chats (MTProto id)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|except\_ids|Array of [int](../types/int.md) | Do not fetch these chats (MTProto id) | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v81/methods/messages_getAllStickers.md b/old_docs/API_docs_v81/methods/messages_getAllStickers.md index e307bd31..f5c70997 100644 --- a/old_docs/API_docs_v81/methods/messages_getAllStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getAllStickers.md @@ -11,9 +11,9 @@ Get all stickerpacks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md b/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md index b2ab58de..e98ab6ec 100644 --- a/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getArchivedStickers.md @@ -11,11 +11,11 @@ Get all archived stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Get masks?| -|offset\_id|[long](../types/long.md) | Yes|Sticker ID offset| -|limit|[int](../types/int.md) | Yes|Number of stickers to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Get masks? | Optional| +|offset\_id|[long](../types/long.md) | Sticker ID offset | Yes| +|limit|[int](../types/int.md) | Number of stickers to fetch | Yes| ### Return type: [messages\_ArchivedStickers](../types/messages_ArchivedStickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md b/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md index bd20bc91..0e221a84 100644 --- a/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getAttachedStickers.md @@ -11,9 +11,9 @@ Get stickers attachable to images ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | Yes|The stickered media| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|media|[InputStickeredMedia](../types/InputStickeredMedia.md) | The stickered media | Yes| ### Return type: [Vector\_of\_StickerSetCovered](../types/StickerSetCovered.md) diff --git a/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md b/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md index f89f60ab..ffcd8a2e 100644 --- a/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md +++ b/old_docs/API_docs_v81/methods/messages_getBotCallbackAnswer.md @@ -11,12 +11,12 @@ Get the callback answer of a bot (after clicking a button) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|game|[Bool](../types/Bool.md) | Optional|Is this a game?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|data|[bytes](../types/bytes.md) | Optional|The data to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|game|[Bool](../types/Bool.md) | Is this a game? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|data|[bytes](../types/bytes.md) | The data to send to the bot | Optional| ### Return type: [messages\_BotCallbackAnswer](../types/messages_BotCallbackAnswer.md) diff --git a/old_docs/API_docs_v81/methods/messages_getChats.md b/old_docs/API_docs_v81/methods/messages_getChats.md index 8a875912..9fd5eadd 100644 --- a/old_docs/API_docs_v81/methods/messages_getChats.md +++ b/old_docs/API_docs_v81/methods/messages_getChats.md @@ -11,9 +11,9 @@ Get info about chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The MTProto IDs of chats to fetch info about| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The MTProto IDs of chats to fetch info about | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v81/methods/messages_getCommonChats.md b/old_docs/API_docs_v81/methods/messages_getCommonChats.md index eb11e88a..e6921d5e 100644 --- a/old_docs/API_docs_v81/methods/messages_getCommonChats.md +++ b/old_docs/API_docs_v81/methods/messages_getCommonChats.md @@ -11,11 +11,11 @@ Get chats in common with a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|max\_id|[int](../types/int.md) | Yes|The maximum chat ID to fetch| -|limit|[int](../types/int.md) | Yes|Number of results to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|max\_id|[int](../types/int.md) | The maximum chat ID to fetch | Yes| +|limit|[int](../types/int.md) | Number of results to fetch | Yes| ### Return type: [messages\_Chats](../types/messages_Chats.md) diff --git a/old_docs/API_docs_v81/methods/messages_getDialogs.md b/old_docs/API_docs_v81/methods/messages_getDialogs.md index 22dc3327..694c916f 100644 --- a/old_docs/API_docs_v81/methods/messages_getDialogs.md +++ b/old_docs/API_docs_v81/methods/messages_getDialogs.md @@ -11,13 +11,13 @@ Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https: ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_pinned|[Bool](../types/Bool.md) | Optional|Do not fetch pinned chats| -|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];| -|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];| -|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional| +|offset\_date|[int](../types/int.md) | end($res['messages'])['date']; | Yes| +|offset\_id|[int](../types/int.md) | end($res['messages'])['id']; | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | end($res['dialogs'])['peer']; | Optional| +|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes| ### Return type: [messages\_Dialogs](../types/messages_Dialogs.md) diff --git a/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md b/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md index 42d9bf88..5b6f6f21 100644 --- a/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md +++ b/old_docs/API_docs_v81/methods/messages_getDocumentByHash.md @@ -11,11 +11,11 @@ Get document by SHA256 hash ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sha256|[bytes](../types/bytes.md) | Yes|`hash('sha256', $filename, true);`| -|size|[int](../types/int.md) | Yes|The file size| -|mime\_type|[string](../types/string.md) | Yes|The mime type of the file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sha256|[bytes](../types/bytes.md) | `hash('sha256', $filename, true);` | Yes| +|size|[int](../types/int.md) | The file size | Yes| +|mime\_type|[string](../types/string.md) | The mime type of the file | Yes| ### Return type: [Document](../types/Document.md) diff --git a/old_docs/API_docs_v81/methods/messages_getFavedStickers.md b/old_docs/API_docs_v81/methods/messages_getFavedStickers.md index cae141f4..4ea69f9f 100644 --- a/old_docs/API_docs_v81/methods/messages_getFavedStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getFavedStickers.md @@ -11,9 +11,9 @@ Get favorite stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FavedStickers](../types/messages_FavedStickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md b/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md index 95b57370..4b2115be 100644 --- a/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getFeaturedStickers.md @@ -11,9 +11,9 @@ Get featured stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_FeaturedStickers](../types/messages_FeaturedStickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getGameHighScores.md b/old_docs/API_docs_v81/methods/messages_getGameHighScores.md index 589d91bf..f7837998 100644 --- a/old_docs/API_docs_v81/methods/messages_getGameHighScores.md +++ b/old_docs/API_docs_v81/methods/messages_getGameHighScores.md @@ -11,11 +11,11 @@ Get high scores of a game ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v81/methods/messages_getHistory.md b/old_docs/API_docs_v81/methods/messages_getHistory.md index 0d6eee5a..7864e4ad 100644 --- a/old_docs/API_docs_v81/methods/messages_getHistory.md +++ b/old_docs/API_docs_v81/methods/messages_getHistory.md @@ -11,16 +11,16 @@ Get previous messages of a group ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|offset\_id|[int](../types/int.md) | Yes|The last fetched message ID, initially 0| -|offset\_date|[int](../types/int.md) | Yes|The date of the last previously fetched message, initially 0| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of messages to fetch| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|Minumum message ID to fetch| -|hash|[int](../types/int.md) | Yes|hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|offset\_id|[int](../types/int.md) | The last fetched message ID, initially 0 | Yes| +|offset\_date|[int](../types/int.md) | The date of the last previously fetched message, initially 0 | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of messages to fetch | Yes| +|max\_id|[int](../types/int.md) | Maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | Minumum message ID to fetch | Yes| +|hash|[int](../types/int.md) | hash of old messages, $MadelineProto->gen_vector_hash($parsedMessageIds) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md b/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md index 7bb2d7bc..03b5d845 100644 --- a/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md +++ b/old_docs/API_docs_v81/methods/messages_getInlineBotResults.md @@ -11,13 +11,13 @@ Call inline bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot to call| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to call the bot| -|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | Optional|The current location| -|query|[string](../types/string.md) | Yes|The query to send to the bot| -|offset|[string](../types/string.md) | Yes|The offset to send to the bot| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot to call | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to call the bot | Optional| +|geo\_point|[InputGeoPoint](../types/InputGeoPoint.md) | The current location | Optional| +|query|[string](../types/string.md) | The query to send to the bot | Yes| +|offset|[string](../types/string.md) | The offset to send to the bot | Yes| ### Return type: [messages\_BotResults](../types/messages_BotResults.md) diff --git a/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md b/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md index 88f20c2a..e8be8e81 100644 --- a/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md +++ b/old_docs/API_docs_v81/methods/messages_getInlineGameHighScores.md @@ -11,10 +11,10 @@ Get high scores of a game sent in an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the high scores| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional| ### Return type: [messages\_HighScores](../types/messages_HighScores.md) diff --git a/old_docs/API_docs_v81/methods/messages_getMaskStickers.md b/old_docs/API_docs_v81/methods/messages_getMaskStickers.md index 7aee3f08..7660ecec 100644 --- a/old_docs/API_docs_v81/methods/messages_getMaskStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getMaskStickers.md @@ -11,9 +11,9 @@ Get masks ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_AllStickers](../types/messages_AllStickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getMessageEditData.md b/old_docs/API_docs_v81/methods/messages_getMessageEditData.md index 6b4f0be2..2c44a1dc 100644 --- a/old_docs/API_docs_v81/methods/messages_getMessageEditData.md +++ b/old_docs/API_docs_v81/methods/messages_getMessageEditData.md @@ -11,10 +11,10 @@ Check if about to edit a message or a media caption ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|id|[int](../types/int.md) | The message ID | Yes| ### Return type: [messages\_MessageEditData](../types/messages_MessageEditData.md) diff --git a/old_docs/API_docs_v81/methods/messages_getMessages.md b/old_docs/API_docs_v81/methods/messages_getMessages.md index c70d48c5..3cd40799 100644 --- a/old_docs/API_docs_v81/methods/messages_getMessages.md +++ b/old_docs/API_docs_v81/methods/messages_getMessages.md @@ -11,9 +11,9 @@ Get messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | Yes|The IDs of messages to fetch (only for users and normal groups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Message ID or InputMessage](../types/InputMessage.md) | The IDs of messages to fetch (only for users and normal groups) | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v81/methods/messages_getMessagesViews.md b/old_docs/API_docs_v81/methods/messages_getMessagesViews.md index 94310603..57a99054 100644 --- a/old_docs/API_docs_v81/methods/messages_getMessagesViews.md +++ b/old_docs/API_docs_v81/methods/messages_getMessagesViews.md @@ -11,11 +11,11 @@ Get and increase message views ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the message is located| -|id|Array of [int](../types/int.md) | Yes|The IDs messages to get| -|increment|[Bool](../types/Bool.md) | Yes|Increase message views?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the message is located | Optional| +|id|Array of [int](../types/int.md) | The IDs messages to get | Yes| +|increment|[Bool](../types/Bool.md) | Increase message views? | Yes| ### Return type: [Vector\_of\_int](../types/int.md) diff --git a/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md b/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md index 61dac347..5c41b5fb 100644 --- a/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md +++ b/old_docs/API_docs_v81/methods/messages_getPeerDialogs.md @@ -11,9 +11,9 @@ Get dialog info of peers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peers|Array of [InputDialogPeer](../types/InputDialogPeer.md) | Yes|The peers| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peers|Array of [InputDialogPeer](../types/InputDialogPeer.md) | The peers | Yes| ### Return type: [messages\_PeerDialogs](../types/messages_PeerDialogs.md) diff --git a/old_docs/API_docs_v81/methods/messages_getPeerSettings.md b/old_docs/API_docs_v81/methods/messages_getPeerSettings.md index 679ba8d5..92d4697a 100644 --- a/old_docs/API_docs_v81/methods/messages_getPeerSettings.md +++ b/old_docs/API_docs_v81/methods/messages_getPeerSettings.md @@ -11,9 +11,9 @@ Get the settings of apeer ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer | Optional| ### Return type: [PeerSettings](../types/PeerSettings.md) diff --git a/old_docs/API_docs_v81/methods/messages_getRecentLocations.md b/old_docs/API_docs_v81/methods/messages_getRecentLocations.md index d839c63c..b3427171 100644 --- a/old_docs/API_docs_v81/methods/messages_getRecentLocations.md +++ b/old_docs/API_docs_v81/methods/messages_getRecentLocations.md @@ -11,11 +11,11 @@ Get recent locations ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to search locations| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched locations, or []);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to search locations | Optional| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched locations, or []); | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v81/methods/messages_getRecentStickers.md b/old_docs/API_docs_v81/methods/messages_getRecentStickers.md index f277eb43..7c17c571 100644 --- a/old_docs/API_docs_v81/methods/messages_getRecentStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getRecentStickers.md @@ -11,10 +11,10 @@ Get recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_RecentStickers](../types/messages_RecentStickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getSavedGifs.md b/old_docs/API_docs_v81/methods/messages_getSavedGifs.md index 5539c012..8edc73c7 100644 --- a/old_docs/API_docs_v81/methods/messages_getSavedGifs.md +++ b/old_docs/API_docs_v81/methods/messages_getSavedGifs.md @@ -11,9 +11,9 @@ Get saved gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [messages\_SavedGifs](../types/messages_SavedGifs.md) diff --git a/old_docs/API_docs_v81/methods/messages_getStickerSet.md b/old_docs/API_docs_v81/methods/messages_getStickerSet.md index bcad8456..29e44f84 100644 --- a/old_docs/API_docs_v81/methods/messages_getStickerSet.md +++ b/old_docs/API_docs_v81/methods/messages_getStickerSet.md @@ -11,9 +11,9 @@ Get a stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset to get| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset to get | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v81/methods/messages_getStickers.md b/old_docs/API_docs_v81/methods/messages_getStickers.md index 7d2822d0..22c3c9ba 100644 --- a/old_docs/API_docs_v81/methods/messages_getStickers.md +++ b/old_docs/API_docs_v81/methods/messages_getStickers.md @@ -11,10 +11,10 @@ Get stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|emoticon|[string](../types/string.md) | Yes|Search by emoji| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched stickers, or []);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|emoticon|[string](../types/string.md) | Search by emoji | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched stickers, or []); | Yes| ### Return type: [messages\_Stickers](../types/messages_Stickers.md) diff --git a/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md b/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md index 88e895e4..9b221db9 100644 --- a/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md +++ b/old_docs/API_docs_v81/methods/messages_getUnreadMentions.md @@ -11,14 +11,14 @@ Get unread mentions ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to get unread mentions| -|offset\_id|[int](../types/int.md) | Yes|The offset| -|add\_offset|[int](../types/int.md) | Yes|The additional offset| -|limit|[int](../types/int.md) | Yes|The number of results to fetch| -|max\_id|[int](../types/int.md) | Yes|The maximum message ID to fetch| -|min\_id|[int](../types/int.md) | Yes|The minumum message ID to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to get unread mentions | Optional| +|offset\_id|[int](../types/int.md) | The offset | Yes| +|add\_offset|[int](../types/int.md) | The additional offset | Yes| +|limit|[int](../types/int.md) | The number of results to fetch | Yes| +|max\_id|[int](../types/int.md) | The maximum message ID to fetch | Yes| +|min\_id|[int](../types/int.md) | The minumum message ID to fetch | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v81/methods/messages_getWebPage.md b/old_docs/API_docs_v81/methods/messages_getWebPage.md index 507708f7..b82c2473 100644 --- a/old_docs/API_docs_v81/methods/messages_getWebPage.md +++ b/old_docs/API_docs_v81/methods/messages_getWebPage.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|url|[string](../types/string.md) | Yes|URL| -|hash|[int](../types/int.md) | Yes|0 or $result['hash']| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|url|[string](../types/string.md) | URL | Yes| +|hash|[int](../types/int.md) | 0 or $result['hash'] | Yes| ### Return type: [WebPage](../types/WebPage.md) diff --git a/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md b/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md index 21652a7b..99ef2e5a 100644 --- a/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md +++ b/old_docs/API_docs_v81/methods/messages_getWebPagePreview.md @@ -11,10 +11,10 @@ Get webpage preview ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|message|[string](../types/string.md) | Yes|Extract preview from this message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|message|[string](../types/string.md) | Extract preview from this message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v81/methods/messages_hideReportSpam.md b/old_docs/API_docs_v81/methods/messages_hideReportSpam.md index f5965c44..17a7f8ef 100644 --- a/old_docs/API_docs_v81/methods/messages_hideReportSpam.md +++ b/old_docs/API_docs_v81/methods/messages_hideReportSpam.md @@ -11,9 +11,9 @@ Hide report spam popup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to hide the popup| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to hide the popup | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_importChatInvite.md b/old_docs/API_docs_v81/methods/messages_importChatInvite.md index 475d619e..f2040b3a 100644 --- a/old_docs/API_docs_v81/methods/messages_importChatInvite.md +++ b/old_docs/API_docs_v81/methods/messages_importChatInvite.md @@ -11,9 +11,9 @@ Import chat invite ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|hash|[string](../types/string.md) | Yes|The invite link in t.me/joinchat/aflakf format| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|hash|[string](../types/string.md) | The invite link in t.me/joinchat/aflakf format | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_installStickerSet.md b/old_docs/API_docs_v81/methods/messages_installStickerSet.md index 162278ba..88131136 100644 --- a/old_docs/API_docs_v81/methods/messages_installStickerSet.md +++ b/old_docs/API_docs_v81/methods/messages_installStickerSet.md @@ -11,10 +11,10 @@ Add a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to add| -|archived|[Bool](../types/Bool.md) | Yes|Archive this set?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to add | Optional| +|archived|[Bool](../types/Bool.md) | Archive this set? | Yes| ### Return type: [messages\_StickerSetInstallResult](../types/messages_StickerSetInstallResult.md) diff --git a/old_docs/API_docs_v81/methods/messages_migrateChat.md b/old_docs/API_docs_v81/methods/messages_migrateChat.md index 243124d9..df91f510 100644 --- a/old_docs/API_docs_v81/methods/messages_migrateChat.md +++ b/old_docs/API_docs_v81/methods/messages_migrateChat.md @@ -11,9 +11,9 @@ Convert chat to supergroup ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat to convert| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat to convert | Optional| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md b/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md index 60a73d27..95b66135 100644 --- a/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md +++ b/old_docs/API_docs_v81/methods/messages_readEncryptedHistory.md @@ -11,10 +11,10 @@ Mark messages as read in secret chats ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to mark messages as read| -|max\_date|[int](../types/int.md) | Yes|Maximum date of messages to mark| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to mark messages as read | Yes| +|max\_date|[int](../types/int.md) | Maximum date of messages to mark | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md b/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md index 5bb44041..2c34ac0f 100644 --- a/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md +++ b/old_docs/API_docs_v81/methods/messages_readFeaturedStickers.md @@ -11,9 +11,9 @@ Mark new featured stickers as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [long](../types/long.md) | Yes|The stickers to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [long](../types/long.md) | The stickers to mark as read | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_readHistory.md b/old_docs/API_docs_v81/methods/messages_readHistory.md index 8c7dfd3a..48d7fb45 100644 --- a/old_docs/API_docs_v81/methods/messages_readHistory.md +++ b/old_docs/API_docs_v81/methods/messages_readHistory.md @@ -11,10 +11,10 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to mark messages as read| -|max\_id|[int](../types/int.md) | Yes|Maximum message ID to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to mark messages as read | Optional| +|max\_id|[int](../types/int.md) | Maximum message ID to mark as read | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v81/methods/messages_readMentions.md b/old_docs/API_docs_v81/methods/messages_readMentions.md index c58cb06a..31874ee6 100644 --- a/old_docs/API_docs_v81/methods/messages_readMentions.md +++ b/old_docs/API_docs_v81/methods/messages_readMentions.md @@ -11,9 +11,9 @@ Mark mentions as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| ### Return type: [messages\_AffectedHistory](../types/messages_AffectedHistory.md) diff --git a/old_docs/API_docs_v81/methods/messages_readMessageContents.md b/old_docs/API_docs_v81/methods/messages_readMessageContents.md index 905fc166..87bd1ea7 100644 --- a/old_docs/API_docs_v81/methods/messages_readMessageContents.md +++ b/old_docs/API_docs_v81/methods/messages_readMessageContents.md @@ -11,9 +11,9 @@ Mark message as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [int](../types/int.md) | Yes|The messages to mark as read (only users and normal chats, not supergroups)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [int](../types/int.md) | The messages to mark as read (only users and normal chats, not supergroups) | Yes| ### Return type: [messages\_AffectedMessages](../types/messages_AffectedMessages.md) diff --git a/old_docs/API_docs_v81/methods/messages_receivedMessages.md b/old_docs/API_docs_v81/methods/messages_receivedMessages.md index a0c6f5e6..8131789e 100644 --- a/old_docs/API_docs_v81/methods/messages_receivedMessages.md +++ b/old_docs/API_docs_v81/methods/messages_receivedMessages.md @@ -11,9 +11,9 @@ Mark messages as read ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|max\_id|[int](../types/int.md) | Yes|Maximum message id of messages to mark as read| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|max\_id|[int](../types/int.md) | Maximum message id of messages to mark as read | Yes| ### Return type: [Vector\_of\_ReceivedNotifyMessage](../types/ReceivedNotifyMessage.md) diff --git a/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md b/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md index d6a517d2..8f5b821d 100644 --- a/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md +++ b/old_docs/API_docs_v81/methods/messages_reorderPinnedDialogs.md @@ -11,10 +11,10 @@ Reorder pinned dialogs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|force|[Bool](../types/Bool.md) | Optional|Force reordering| -|order|Array of [InputDialogPeer](../types/InputDialogPeer.md) | Yes|New order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|force|[Bool](../types/Bool.md) | Force reordering | Optional| +|order|Array of [InputDialogPeer](../types/InputDialogPeer.md) | New order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md b/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md index 5ef52708..c1c35ef6 100644 --- a/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md +++ b/old_docs/API_docs_v81/methods/messages_reorderStickerSets.md @@ -11,10 +11,10 @@ Reorder sticker sets ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Reorder masks?| -|order|Array of [long](../types/long.md) | Yes|The order| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Reorder masks? | Optional| +|order|Array of [long](../types/long.md) | The order | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_report.md b/old_docs/API_docs_v81/methods/messages_report.md index f10246ed..8c940d7f 100644 --- a/old_docs/API_docs_v81/methods/messages_report.md +++ b/old_docs/API_docs_v81/methods/messages_report.md @@ -11,11 +11,11 @@ Report a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The user that sent the messages| -|id|Array of [int](../types/int.md) | Yes|The messages to report| -|reason|[ReportReason](../types/ReportReason.md) | Yes|The reason why you're sending this report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The user that sent the messages | Optional| +|id|Array of [int](../types/int.md) | The messages to report | Yes| +|reason|[ReportReason](../types/ReportReason.md) | The reason why you're sending this report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md b/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md index e3b9f626..dffdffc9 100644 --- a/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md +++ b/old_docs/API_docs_v81/methods/messages_reportEncryptedSpam.md @@ -11,9 +11,9 @@ Report for spam a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat to report | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_reportSpam.md b/old_docs/API_docs_v81/methods/messages_reportSpam.md index 9ff07f9e..da5934b8 100644 --- a/old_docs/API_docs_v81/methods/messages_reportSpam.md +++ b/old_docs/API_docs_v81/methods/messages_reportSpam.md @@ -11,9 +11,9 @@ Report a peer for spam ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The peer to report| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The peer to report | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_saveDraft.md b/old_docs/API_docs_v81/methods/messages_saveDraft.md index 56b0640c..04375c75 100644 --- a/old_docs/API_docs_v81/methods/messages_saveDraft.md +++ b/old_docs/API_docs_v81/methods/messages_saveDraft.md @@ -11,13 +11,13 @@ Save a message draft ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat| -|message|[string](../types/string.md) | Yes|The message| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|The entities (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional| +|message|[string](../types/string.md) | The message | Yes| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | The entities (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v81/methods/messages_saveGif.md b/old_docs/API_docs_v81/methods/messages_saveGif.md index 427069df..adae6d86 100644 --- a/old_docs/API_docs_v81/methods/messages_saveGif.md +++ b/old_docs/API_docs_v81/methods/messages_saveGif.md @@ -11,10 +11,10 @@ Save a GIF ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The GIF to save| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the gif?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The GIF to save | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the gif? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md b/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md index abfd1f22..9cd06ea1 100644 --- a/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md +++ b/old_docs/API_docs_v81/methods/messages_saveRecentSticker.md @@ -11,11 +11,11 @@ Add a sticker to recent stickers ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|attached|[Bool](../types/Bool.md) | Optional|Get stickers attached to image?| -|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|unsave|[Bool](../types/Bool.md) | Yes|Remove the sticker from recent stickers?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|attached|[Bool](../types/Bool.md) | Get stickers attached to image? | Optional| +|id|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|unsave|[Bool](../types/Bool.md) | Remove the sticker from recent stickers? | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_search.md b/old_docs/API_docs_v81/methods/messages_search.md index e20ba0a3..f778a9d5 100644 --- a/old_docs/API_docs_v81/methods/messages_search.md +++ b/old_docs/API_docs_v81/methods/messages_search.md @@ -11,20 +11,20 @@ Search peers or messages ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search| -|q|[string](../types/string.md) | Yes|What to search| -|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|Show only messages from a certain user?| -|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter| -|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch| -|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch| -|offset\_id|[int](../types/int.md) | Yes|Message ID offset| -|add\_offset|[int](../types/int.md) | Yes|Additional offset, can be 0| -|limit|[int](../types/int.md) | Yes|Number of results to return| -|max\_id|[int](../types/int.md) | Yes|Maximum message id to return| -|min\_id|[int](../types/int.md) | Yes|Minumum message id to return| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously fetched messages);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional| +|q|[string](../types/string.md) | What to search | Yes| +|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional| +|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Yes| +|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes| +|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes| +|offset\_id|[int](../types/int.md) | Message ID offset | Yes| +|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes| +|limit|[int](../types/int.md) | Number of results to return | Yes| +|max\_id|[int](../types/int.md) | Maximum message id to return | Yes| +|min\_id|[int](../types/int.md) | Minumum message id to return | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously fetched messages); | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v81/methods/messages_searchGifs.md b/old_docs/API_docs_v81/methods/messages_searchGifs.md index 72112b7c..1ef77d23 100644 --- a/old_docs/API_docs_v81/methods/messages_searchGifs.md +++ b/old_docs/API_docs_v81/methods/messages_searchGifs.md @@ -11,10 +11,10 @@ Search gifs ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The search query| -|offset|[int](../types/int.md) | Yes|The offset | +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The search query | Yes| +|offset|[int](../types/int.md) | The offset | Yes| ### Return type: [messages\_FoundGifs](../types/messages_FoundGifs.md) diff --git a/old_docs/API_docs_v81/methods/messages_searchGlobal.md b/old_docs/API_docs_v81/methods/messages_searchGlobal.md index 75059706..4d05bf0d 100644 --- a/old_docs/API_docs_v81/methods/messages_searchGlobal.md +++ b/old_docs/API_docs_v81/methods/messages_searchGlobal.md @@ -11,13 +11,13 @@ Global message search ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|q|[string](../types/string.md) | Yes|The query| -|offset\_date|[int](../types/int.md) | Yes|0 or the date offset| -|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset| -|offset\_id|[int](../types/int.md) | Yes|0 or the message ID offset| -|limit|[int](../types/int.md) | Yes|The number of results to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|q|[string](../types/string.md) | The query | Yes| +|offset\_date|[int](../types/int.md) | 0 or the date offset | Yes| +|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | 0 or the peer offset | Optional| +|offset\_id|[int](../types/int.md) | 0 or the message ID offset | Yes| +|limit|[int](../types/int.md) | The number of results to return | Yes| ### Return type: [messages\_Messages](../types/messages_Messages.md) diff --git a/old_docs/API_docs_v81/methods/messages_searchStickerSets.md b/old_docs/API_docs_v81/methods/messages_searchStickerSets.md index aeae2eea..4c386aea 100644 --- a/old_docs/API_docs_v81/methods/messages_searchStickerSets.md +++ b/old_docs/API_docs_v81/methods/messages_searchStickerSets.md @@ -11,11 +11,11 @@ Find a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|exclude\_featured|[Bool](../types/Bool.md) | Optional|Exclude featured sticker sets from the search?| -|q|[string](../types/string.md) | Yes|The search query| -|hash|[int](../types/int.md) | Yes|$MadelineProto->gen_vector_hash(ids of previously searched stickers, or []);| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|exclude\_featured|[Bool](../types/Bool.md) | Exclude featured sticker sets from the search? | Optional| +|q|[string](../types/string.md) | The search query | Yes| +|hash|[int](../types/int.md) | $MadelineProto->gen_vector_hash(ids of previously searched stickers, or []); | Yes| ### Return type: [messages\_FoundStickerSets](../types/messages_FoundStickerSets.md) diff --git a/old_docs/API_docs_v81/methods/messages_sendEncrypted.md b/old_docs/API_docs_v81/methods/messages_sendEncrypted.md index 60e39273..5c80b0d9 100644 --- a/old_docs/API_docs_v81/methods/messages_sendEncrypted.md +++ b/old_docs/API_docs_v81/methods/messages_sendEncrypted.md @@ -11,10 +11,10 @@ Send message to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message to send| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message to send | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md b/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md index b19fb862..68d98b46 100644 --- a/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md +++ b/old_docs/API_docs_v81/methods/messages_sendEncryptedFile.md @@ -11,11 +11,11 @@ Send a file to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the file| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The message with the file| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file (optional)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the file | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The message with the file | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file (optional) | Optional| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md b/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md index 3d0e1507..95eba01a 100644 --- a/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md +++ b/old_docs/API_docs_v81/methods/messages_sendEncryptedService.md @@ -11,10 +11,10 @@ Send a service message to a secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message| -|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes| +|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes| ### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) diff --git a/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md b/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md index 354855a0..8de674c6 100644 --- a/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md +++ b/old_docs/API_docs_v81/methods/messages_sendInlineBotResult.md @@ -11,15 +11,15 @@ Send inline bot result obtained with messages.getInlineBotResults to the chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|query\_id|[long](../types/long.md) | Yes|The inline query ID| -|id|[string](../types/string.md) | Yes|The ID of one of the inline results| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|query\_id|[long](../types/long.md) | The inline query ID | Yes| +|id|[string](../types/string.md) | The ID of one of the inline results | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_sendMedia.md b/old_docs/API_docs_v81/methods/messages_sendMedia.md index a795c5d1..738c6df9 100644 --- a/old_docs/API_docs_v81/methods/messages_sendMedia.md +++ b/old_docs/API_docs_v81/methods/messages_sendMedia.md @@ -11,17 +11,17 @@ Send a media ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the media| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to send| -|message|[string](../types/string.md) | Yes|The caption| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities for styled text| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the media | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to send | Optional| +|message|[string](../types/string.md) | The caption | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities for styled text | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| @@ -127,6 +127,7 @@ MadelineProto supports all html entities supported by [html_entity_decode](http: |EXTERNAL_URL_INVALID|External URL invalid| |FILE_PART_LENGTH_INVALID|The length of a file part is invalid| |FILE_PARTS_INVALID|The number of file parts is invalid| +|IMAGE_PROCESS_FAILED|Failure while processing image| |INPUT_USER_DEACTIVATED|The specified user was deleted| |MEDIA_CAPTION_TOO_LONG|The caption is too long| |MEDIA_EMPTY|The provided media object is invalid| diff --git a/old_docs/API_docs_v81/methods/messages_sendMessage.md b/old_docs/API_docs_v81/methods/messages_sendMessage.md index 668d3d4b..ad4c6519 100644 --- a/old_docs/API_docs_v81/methods/messages_sendMessage.md +++ b/old_docs/API_docs_v81/methods/messages_sendMessage.md @@ -11,17 +11,17 @@ Send a message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|no\_webpage|[Bool](../types/Bool.md) | Optional|Disable webpage preview?| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notifications?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear the message draft of this chat?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where to send this message| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|message|[string](../types/string.md) | Yes|The message to send| -|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Optional|Keyboards to send| -|entities|Array of [MessageEntity](../types/MessageEntity.md) | Optional|Entities to send (for styled text)| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|no\_webpage|[Bool](../types/Bool.md) | Disable webpage preview? | Optional| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notifications? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear the message draft of this chat? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where to send this message | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|message|[string](../types/string.md) | The message to send | Yes| +|reply\_markup|[ReplyMarkup](../types/ReplyMarkup.md) | Keyboards to send | Optional| +|entities|Array of [MessageEntity](../types/MessageEntity.md) | Entities to send (for styled text) | Optional| |parse\_mode| [string](../types/string.md) | Optional |Whether to parse HTML or Markdown markup in the message| diff --git a/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md b/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md index 92baa8ab..115d2f60 100644 --- a/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md +++ b/old_docs/API_docs_v81/methods/messages_sendMultiMedia.md @@ -11,14 +11,14 @@ Send an album ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|silent|[Bool](../types/Bool.md) | Optional|Disable notifications?| -|background|[Bool](../types/Bool.md) | Optional|Disable background notification?| -|clear\_draft|[Bool](../types/Bool.md) | Optional|Clear draft?| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the album| -|reply\_to\_msg\_id|[int](../types/int.md) | Optional|Reply to message by ID| -|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | Yes|The album| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|silent|[Bool](../types/Bool.md) | Disable notifications? | Optional| +|background|[Bool](../types/Bool.md) | Disable background notification? | Optional| +|clear\_draft|[Bool](../types/Bool.md) | Clear draft? | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the album | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Optional| +|multi\_media|Array of [InputSingleMedia](../types/InputSingleMedia.md) | The album | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md b/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md index ac1c1c91..3a71c404 100644 --- a/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md +++ b/old_docs/API_docs_v81/methods/messages_sendScreenshotNotification.md @@ -11,10 +11,10 @@ Send screenshot notification ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to send the notification| -|reply\_to\_msg\_id|[int](../types/int.md) | Yes|Reply to message by ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to send the notification | Optional| +|reply\_to\_msg\_id|[int](../types/int.md) | Reply to message by ID | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md b/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md index f0f04b29..0395b468 100644 --- a/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md +++ b/old_docs/API_docs_v81/methods/messages_setBotCallbackAnswer.md @@ -11,13 +11,13 @@ Bots only: set the callback answer (after a button was clicked) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|alert|[Bool](../types/Bool.md) | Optional|Is this an alert?| -|query\_id|[long](../types/long.md) | Yes|The query ID| -|message|[string](../types/string.md) | Optional|The message| -|url|[string](../types/string.md) | Optional|The URL| -|cache\_time|[int](../types/int.md) | Yes|Cache time| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|alert|[Bool](../types/Bool.md) | Is this an alert? | Optional| +|query\_id|[long](../types/long.md) | The query ID | Yes| +|message|[string](../types/string.md) | The message | Optional| +|url|[string](../types/string.md) | The URL | Optional| +|cache\_time|[int](../types/int.md) | Cache time | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md b/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md index 6d8e2610..486ab585 100644 --- a/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md +++ b/old_docs/API_docs_v81/methods/messages_setBotPrecheckoutResults.md @@ -11,11 +11,11 @@ Bots only: set precheckout results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|success|[Bool](../types/Bool.md) | Optional|Success?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|success|[Bool](../types/Bool.md) | Success? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md b/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md index ea8fec6a..a9e43c49 100644 --- a/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md +++ b/old_docs/API_docs_v81/methods/messages_setBotShippingResults.md @@ -11,11 +11,11 @@ Bots only: set shipping results ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|error|[string](../types/string.md) | Optional|Error| -|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Optional|Shipping options| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|error|[string](../types/string.md) | Error | Optional| +|shipping\_options|Array of [ShippingOption](../types/ShippingOption.md) | Shipping options | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md b/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md index c3054ea8..bb49e2b8 100644 --- a/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md +++ b/old_docs/API_docs_v81/methods/messages_setEncryptedTyping.md @@ -11,10 +11,10 @@ Send typing notification to secret chat ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The secret chat where to send the notification| -|typing|[Bool](../types/Bool.md) | Yes|Set to true to enable the notification, false to disable it| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The secret chat where to send the notification | Yes| +|typing|[Bool](../types/Bool.md) | Set to true to enable the notification, false to disable it | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_setGameScore.md b/old_docs/API_docs_v81/methods/messages_setGameScore.md index 22480566..41ee4591 100644 --- a/old_docs/API_docs_v81/methods/messages_setGameScore.md +++ b/old_docs/API_docs_v81/methods/messages_setGameScore.md @@ -11,14 +11,14 @@ Set the game score ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|The chat where the game was sent| -|id|[int](../types/int.md) | Yes|The message ID| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat where the game was sent | Optional| +|id|[int](../types/int.md) | The message ID | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md b/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md index 2611c3e8..443a028e 100644 --- a/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md +++ b/old_docs/API_docs_v81/methods/messages_setInlineBotResults.md @@ -11,15 +11,15 @@ Bots only: set the results of an inline query ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|gallery|[Bool](../types/Bool.md) | Optional|Is this a gallery?| -|private|[Bool](../types/Bool.md) | Optional|Is this result private (not cached)?| -|query\_id|[long](../types/long.md) | Yes|Query ID| -|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Yes|Results| -|cache\_time|[int](../types/int.md) | Yes|Cache time| -|next\_offset|[string](../types/string.md) | Optional|The next offset| -|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Optional|Switch to PM?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|gallery|[Bool](../types/Bool.md) | Is this a gallery? | Optional| +|private|[Bool](../types/Bool.md) | Is this result private (not cached)? | Optional| +|query\_id|[long](../types/long.md) | Query ID | Yes| +|results|Array of [InputBotInlineResult](../types/InputBotInlineResult.md) | Results | Yes| +|cache\_time|[int](../types/int.md) | Cache time | Yes| +|next\_offset|[string](../types/string.md) | The next offset | Optional| +|switch\_pm|[InlineBotSwitchPM](../types/InlineBotSwitchPM.md) | Switch to PM? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md b/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md index 32af7c16..0d97b9bf 100644 --- a/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md +++ b/old_docs/API_docs_v81/methods/messages_setInlineGameScore.md @@ -11,13 +11,13 @@ Set the game score of an inline message ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|edit\_message|[Bool](../types/Bool.md) | Optional|Should the message with the game be edited?| -|force|[Bool](../types/Bool.md) | Optional|Force setting the game score| -|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|The ID of the inline message| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user that set the score| -|score|[int](../types/int.md) | Yes|The score| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|edit\_message|[Bool](../types/Bool.md) | Should the message with the game be edited? | Optional| +|force|[Bool](../types/Bool.md) | Force setting the game score | Optional| +|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | The ID of the inline message | Yes| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the score | Optional| +|score|[int](../types/int.md) | The score | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_setTyping.md b/old_docs/API_docs_v81/methods/messages_setTyping.md index 3abdcf5b..67ded538 100644 --- a/old_docs/API_docs_v81/methods/messages_setTyping.md +++ b/old_docs/API_docs_v81/methods/messages_setTyping.md @@ -11,10 +11,10 @@ Change typing status ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to change typing status| -|action|[SendMessageAction](../types/SendMessageAction.md) | Yes|Typing status| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to change typing status | Optional| +|action|[SendMessageAction](../types/SendMessageAction.md) | Typing status | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_startBot.md b/old_docs/API_docs_v81/methods/messages_startBot.md index 9f450c72..506957a7 100644 --- a/old_docs/API_docs_v81/methods/messages_startBot.md +++ b/old_docs/API_docs_v81/methods/messages_startBot.md @@ -11,11 +11,11 @@ Start a bot ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The bot's ID or username| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to start the bot (@me or group ID/username)| -|start\_param|[string](../types/string.md) | Yes|The bot's start parameter| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|bot|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The bot's ID or username | Optional| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to start the bot (@me or group ID/username) | Optional| +|start\_param|[string](../types/string.md) | The bot's start parameter | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md b/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md index 676b7f3b..0f1e56fa 100644 --- a/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md +++ b/old_docs/API_docs_v81/methods/messages_toggleChatAdmins.md @@ -11,10 +11,10 @@ Enable all users are admins in normal groups (not supergroups) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Group ID| -|enabled|[Bool](../types/Bool.md) | Yes|Enable all users are admins| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|chat\_id|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Group ID | Optional| +|enabled|[Bool](../types/Bool.md) | Enable all users are admins | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md b/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md index 45c628d9..ee17a462 100644 --- a/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md +++ b/old_docs/API_docs_v81/methods/messages_toggleDialogPin.md @@ -11,10 +11,10 @@ Pin or unpin dialog ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|pinned|[Bool](../types/Bool.md) | Optional|Pin or unpin the dialog?| -|peer|[InputDialogPeer](../types/InputDialogPeer.md) | Yes|The dialog to pin| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|pinned|[Bool](../types/Bool.md) | Pin or unpin the dialog? | Optional| +|peer|[InputDialogPeer](../types/InputDialogPeer.md) | The dialog to pin | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md b/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md index d888ab55..d4c8e173 100644 --- a/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md +++ b/old_docs/API_docs_v81/methods/messages_uninstallStickerSet.md @@ -11,9 +11,9 @@ Remove a sticker set ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The sticker set to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The sticker set to remove | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md b/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md index abb08479..91159bb5 100644 --- a/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md +++ b/old_docs/API_docs_v81/methods/messages_uploadEncryptedFile.md @@ -11,10 +11,10 @@ Upload a secret chat file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to upload the media| -|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|The file| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to upload the media | Yes| +|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | The file | Optional| ### Return type: [EncryptedFile](../types/EncryptedFile.md) diff --git a/old_docs/API_docs_v81/methods/messages_uploadMedia.md b/old_docs/API_docs_v81/methods/messages_uploadMedia.md index 8013f434..65fed5f8 100644 --- a/old_docs/API_docs_v81/methods/messages_uploadMedia.md +++ b/old_docs/API_docs_v81/methods/messages_uploadMedia.md @@ -11,10 +11,10 @@ Upload a file without sending it to anyone ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Nothing| -|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media to upload| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Nothing | Optional| +|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media to upload | Optional| ### Return type: [MessageMedia](../types/MessageMedia.md) diff --git a/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md b/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md index 2af9639f..8ac2d538 100644 --- a/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md +++ b/old_docs/API_docs_v81/methods/payments_clearSavedInfo.md @@ -11,10 +11,10 @@ Clear saved payments info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|credentials|[Bool](../types/Bool.md) | Optional|Clear credentials?| -|info|[Bool](../types/Bool.md) | Optional|Clear payment info?| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|credentials|[Bool](../types/Bool.md) | Clear credentials? | Optional| +|info|[Bool](../types/Bool.md) | Clear payment info? | Optional| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/payments_getPaymentForm.md b/old_docs/API_docs_v81/methods/payments_getPaymentForm.md index 52ea573e..c53c7d10 100644 --- a/old_docs/API_docs_v81/methods/payments_getPaymentForm.md +++ b/old_docs/API_docs_v81/methods/payments_getPaymentForm.md @@ -11,9 +11,9 @@ Get payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| ### Return type: [payments\_PaymentForm](../types/payments_PaymentForm.md) diff --git a/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md b/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md index 4c21b97d..b6bbb3e5 100644 --- a/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md +++ b/old_docs/API_docs_v81/methods/payments_getPaymentReceipt.md @@ -11,9 +11,9 @@ Get payment receipt ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|The message ID| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | The message ID | Yes| ### Return type: [payments\_PaymentReceipt](../types/payments_PaymentReceipt.md) diff --git a/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md b/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md index 80435dcd..5ac22160 100644 --- a/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md +++ b/old_docs/API_docs_v81/methods/payments_sendPaymentForm.md @@ -11,12 +11,12 @@ Bots only: send payment form ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|msg\_id|[int](../types/int.md) | Yes|Message ID| -|requested\_info\_id|[string](../types/string.md) | Optional|ID of requested info| -|shipping\_option\_id|[string](../types/string.md) | Optional|Shipping option ID| -|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Yes|Payment credentials| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|msg\_id|[int](../types/int.md) | Message ID | Yes| +|requested\_info\_id|[string](../types/string.md) | ID of requested info | Optional| +|shipping\_option\_id|[string](../types/string.md) | Shipping option ID | Optional| +|credentials|[InputPaymentCredentials](../types/InputPaymentCredentials.md) | Payment credentials | Yes| ### Return type: [payments\_PaymentResult](../types/payments_PaymentResult.md) diff --git a/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md b/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md index f9694b3f..bc60d68f 100644 --- a/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md +++ b/old_docs/API_docs_v81/methods/payments_validateRequestedInfo.md @@ -11,11 +11,11 @@ Validate requested payment info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|save|[Bool](../types/Bool.md) | Optional|Save payment info?| -|msg\_id|[int](../types/int.md) | Yes|The message ID| -|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | Yes|The requested payment info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|save|[Bool](../types/Bool.md) | Save payment info? | Optional| +|msg\_id|[int](../types/int.md) | The message ID | Yes| +|info|[PaymentRequestedInfo](../types/PaymentRequestedInfo.md) | The requested payment info | Yes| ### Return type: [payments\_ValidatedRequestedInfo](../types/payments_ValidatedRequestedInfo.md) diff --git a/old_docs/API_docs_v81/methods/phone_receivedCall.md b/old_docs/API_docs_v81/methods/phone_receivedCall.md index 3482b99f..b6cebd0c 100644 --- a/old_docs/API_docs_v81/methods/phone_receivedCall.md +++ b/old_docs/API_docs_v81/methods/phone_receivedCall.md @@ -11,9 +11,9 @@ Notify server that you received a call (server will refuse all incoming calls un ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call you received| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call you received | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/phone_saveCallDebug.md b/old_docs/API_docs_v81/methods/phone_saveCallDebug.md index b8c766c1..176f0838 100644 --- a/old_docs/API_docs_v81/methods/phone_saveCallDebug.md +++ b/old_docs/API_docs_v81/methods/phone_saveCallDebug.md @@ -11,10 +11,10 @@ Save call debugging info ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The call| -|debug|[DataJSON](../types/DataJSON.md) | Yes|Debugging info| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The call | Yes| +|debug|[DataJSON](../types/DataJSON.md) | Debugging info | Yes| ### Return type: [Bool](../types/Bool.md) diff --git a/old_docs/API_docs_v81/methods/phone_setCallRating.md b/old_docs/API_docs_v81/methods/phone_setCallRating.md index c0ff0c2f..0861c10e 100644 --- a/old_docs/API_docs_v81/methods/phone_setCallRating.md +++ b/old_docs/API_docs_v81/methods/phone_setCallRating.md @@ -11,11 +11,11 @@ Set phone call rating ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|peer|[InputPhoneCall](../types/InputPhoneCall.md) | Yes|The phone call| -|rating|[int](../types/int.md) | Yes|Rating (1-5 stars)| -|comment|[string](../types/string.md) | Yes|An optional comment| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|peer|[InputPhoneCall](../types/InputPhoneCall.md) | The phone call | Yes| +|rating|[int](../types/int.md) | Rating (1-5 stars) | Yes| +|comment|[string](../types/string.md) | An optional comment | Yes| ### Return type: [Updates](../types/Updates.md) diff --git a/old_docs/API_docs_v81/methods/photos_deletePhotos.md b/old_docs/API_docs_v81/methods/photos_deletePhotos.md index fd8571d2..0c29768f 100644 --- a/old_docs/API_docs_v81/methods/photos_deletePhotos.md +++ b/old_docs/API_docs_v81/methods/photos_deletePhotos.md @@ -11,9 +11,9 @@ Delete profile photos ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Yes|The profile photos to delete| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The profile photos to delete | Yes| ### Return type: [Vector\_of\_long](../types/long.md) diff --git a/old_docs/API_docs_v81/methods/photos_getUserPhotos.md b/old_docs/API_docs_v81/methods/photos_getUserPhotos.md index 189b72e7..815be8cd 100644 --- a/old_docs/API_docs_v81/methods/photos_getUserPhotos.md +++ b/old_docs/API_docs_v81/methods/photos_getUserPhotos.md @@ -11,12 +11,12 @@ Get the profile photos of a user ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user| -|offset|[int](../types/int.md) | Yes|Offset| -|max\_id|[long](../types/long.md) | Yes|Maximum ID of photo to return| -|limit|[int](../types/int.md) | Yes|Number of photos to return| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user | Optional| +|offset|[int](../types/int.md) | Offset | Yes| +|max\_id|[long](../types/long.md) | Maximum ID of photo to return | Yes| +|limit|[int](../types/int.md) | Number of photos to return | Yes| ### Return type: [photos\_Photos](../types/photos_Photos.md) diff --git a/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md b/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md index 24357a4b..8eb42e5d 100644 --- a/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md +++ b/old_docs/API_docs_v81/methods/photos_updateProfilePhoto.md @@ -11,9 +11,9 @@ Update the profile photo (use photos->uploadProfilePhoto to upload the photo) ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | Optional|The photo to use| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[MessageMedia, Update, Message or InputPhoto](../types/InputPhoto.md) | The photo to use | Optional| ### Return type: [UserProfilePhoto](../types/UserProfilePhoto.md) diff --git a/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md b/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md index 71ba3044..9b838b89 100644 --- a/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md +++ b/old_docs/API_docs_v81/methods/photos_uploadProfilePhoto.md @@ -11,9 +11,9 @@ Upload profile photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|file|[File path or InputFile](../types/InputFile.md) | Yes|The photo| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|file|[File path or InputFile](../types/InputFile.md) | The photo | Yes| ### Return type: [photos\_Photo](../types/photos_Photo.md) diff --git a/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md b/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md index 81605d27..7029d543 100644 --- a/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md +++ b/old_docs/API_docs_v81/methods/stickers_addStickerToSet.md @@ -11,10 +11,10 @@ Add sticker to stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|stickerset|[InputStickerSet](../types/InputStickerSet.md) | Optional|The stickerset| -|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The sticker| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|stickerset|[InputStickerSet](../types/InputStickerSet.md) | The stickerset | Optional| +|sticker|[InputStickerSetItem](../types/InputStickerSetItem.md) | The sticker | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md b/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md index df9e344d..e6a2951e 100644 --- a/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md +++ b/old_docs/API_docs_v81/methods/stickers_changeStickerPosition.md @@ -11,10 +11,10 @@ Change sticker position in photo ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker| -|position|[int](../types/int.md) | Yes|New position| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker | Optional| +|position|[int](../types/int.md) | New position | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v81/methods/stickers_createStickerSet.md b/old_docs/API_docs_v81/methods/stickers_createStickerSet.md index 3dd60721..58ed89b7 100644 --- a/old_docs/API_docs_v81/methods/stickers_createStickerSet.md +++ b/old_docs/API_docs_v81/methods/stickers_createStickerSet.md @@ -11,13 +11,13 @@ Create stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|masks|[Bool](../types/Bool.md) | Optional|Masks?| -|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID associated to this stickerset| -|title|[string](../types/string.md) | Yes|The stickerset title| -|short\_name|[string](../types/string.md) | Yes|The stickerset short name| -|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | Yes|The stickers to add| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|masks|[Bool](../types/Bool.md) | Masks? | Optional| +|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID associated to this stickerset | Optional| +|title|[string](../types/string.md) | The stickerset title | Yes| +|short\_name|[string](../types/string.md) | The stickerset short name | Yes| +|stickers|Array of [InputStickerSetItem](../types/InputStickerSetItem.md) | The stickers to add | Yes| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md b/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md index e8444adb..7349779f 100644 --- a/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md +++ b/old_docs/API_docs_v81/methods/stickers_removeStickerFromSet.md @@ -11,9 +11,9 @@ Remove sticker from stickerset ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | Optional|The sticker to remove| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|sticker|[MessageMedia, Update, Message or InputDocument](../types/InputDocument.md) | The sticker to remove | Optional| ### Return type: [messages\_StickerSet](../types/messages_StickerSet.md) diff --git a/old_docs/API_docs_v81/methods/upload_getWebFile.md b/old_docs/API_docs_v81/methods/upload_getWebFile.md index 18a0955c..d7d5d631 100644 --- a/old_docs/API_docs_v81/methods/upload_getWebFile.md +++ b/old_docs/API_docs_v81/methods/upload_getWebFile.md @@ -11,11 +11,11 @@ Download a file through telegram ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | Yes|The file| -|offset|[int](../types/int.md) | Yes|The offset in bytes| -|limit|[int](../types/int.md) | Yes|The number of bytes to fetch| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|location|[InputWebFileLocation](../types/InputWebFileLocation.md) | The file | Yes| +|offset|[int](../types/int.md) | The offset in bytes | Yes| +|limit|[int](../types/int.md) | The number of bytes to fetch | Yes| ### Return type: [upload\_WebFile](../types/upload_WebFile.md) diff --git a/old_docs/API_docs_v81/methods/users_getUsers.md b/old_docs/API_docs_v81/methods/users_getUsers.md index cb09a74d..5e8d2aac 100644 --- a/old_docs/API_docs_v81/methods/users_getUsers.md +++ b/old_docs/API_docs_v81/methods/users_getUsers.md @@ -11,9 +11,9 @@ Get info about users ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The ids of the users| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The ids of the users | Yes| ### Return type: [Vector\_of\_User](../types/User.md) diff --git a/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md b/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md index 11293a49..4e18012c 100644 --- a/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md +++ b/old_docs/API_docs_v81/methods/users_setSecureValueErrors.md @@ -11,10 +11,10 @@ Set secure value error for telegram passport ### Parameters: -| Name | Type | Required | Description | -|----------|---------------|----------|-------------| -|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Optional|The user ID| -|errors|Array of [SecureValueError](../types/SecureValueError.md) | Yes|The errors| +| Name | Type | Description | Required | +|----------|---------------|-------------|----------| +|id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user ID | Optional| +|errors|Array of [SecureValueError](../types/SecureValueError.md) | The errors | Yes| ### Return type: [Bool](../types/Bool.md)