diff --git a/TLScheme.json b/TLScheme.json index 2c281e3..cad07c2 100644 --- a/TLScheme.json +++ b/TLScheme.json @@ -1,3 +1,4 @@ +Obtaining TLScheme from https://raw.githubusercontent.com/tdlib/td/master/td/generate/scheme/td_api.tl [ { "name": "error", @@ -28,91 +29,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "tdlibParameters", - "methods": [ - { - "name": "use_test_dc", - "type": "Bool", - "description": "If set to true, the Telegram test environment will be used instead of the production environment" - }, - { - "name": "database_directory", - "type": "string", - "description": "The path to the directory for the persistent database; if empty, the current working directory will be used" - }, - { - "name": "files_directory", - "type": "string", - "description": "The path to the directory for storing files; if empty, database_directory will be used" - }, - { - "name": "use_file_database", - "type": "Bool", - "description": "If set to true, information about downloaded and uploaded files will be saved between application restarts" - }, - { - "name": "use_chat_info_database", - "type": "Bool", - "description": "If set to true, the library will maintain a cache of users, basic groups, supergroups, channels and secret chats. Implies use_file_database" - }, - { - "name": "use_message_database", - "type": "Bool", - "description": "If set to true, the library will maintain a cache of chats and messages. Implies use_chat_info_database" - }, - { - "name": "use_secret_chats", - "type": "Bool", - "description": "If set to true, support for secret chats will be enabled" - }, - { - "name": "api_id", - "type": "int32", - "description": "Application identifier for Telegram API access, which can be obtained at https://my.telegram.org" - }, - { - "name": "api_hash", - "type": "string", - "description": "Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org" - }, - { - "name": "system_language_code", - "type": "string", - "description": "IETF language tag of the user's operating system language; must be non-empty" - }, - { - "name": "device_model", - "type": "string", - "description": "Model of the device the application is being run on; must be non-empty" - }, - { - "name": "system_version", - "type": "string", - "description": "Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib" - }, - { - "name": "application_version", - "type": "string", - "description": "Application version; must be non-empty" - }, - { - "name": "enable_storage_optimizer", - "type": "Bool", - "description": "If set to true, old files will automatically be deleted" - }, - { - "name": "ignore_file_names", - "type": "Bool", - "description": "If set to true, original file names will be ignored. Otherwise, downloaded files will be saved under names as close as possible to the original name" - } - ], - "description": "Contains parameters for TDLib initialization", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "AuthenticationCodeType", "methods": null, @@ -176,7 +92,27 @@ "description": "Pattern of the phone number from which the call will be made" } ], - "description": "An authentication code is delivered by an immediately cancelled call to the specified phone number. The number from which the call was made is the code", + "description": "An authentication code is delivered by an immediately canceled call to the specified phone number. The phone number that calls is the code that must be entered automatically", + "inheritance": "AuthenticationCodeType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "authenticationCodeTypeMissedCall", + "methods": [ + { + "name": "phone_number_prefix", + "type": "string", + "description": "Prefix of the phone number from which the call will be made" + }, + { + "name": "length", + "type": "int32", + "description": "Number of digits in the code, excluding the prefix" + } + ], + "description": "An authentication code is delivered by an immediately canceled call to the specified phone number. The last digits of the phone number that calls are the code that must be entered manually by the user", "inheritance": "AuthenticationCodeType", "return_type": "", "isFunction": false, @@ -193,17 +129,17 @@ { "name": "type", "type": "AuthenticationCodeType", - "description": "Describes the way the code was sent to the user" + "description": "The way the code was sent to the user" }, { "name": "next_type", "type": "AuthenticationCodeType", - "description": "Describes the way the next code will be sent to the user; may be null" + "description": "The way the next code will be sent to the user; may be null" }, { "name": "timeout", "type": "int32", - "description": "Timeout before the code should be re-sent, in seconds" + "description": "Timeout before the code can be re-sent, in seconds" } ], "description": "Information about the authentication code that was sent", @@ -232,6 +168,60 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "EmailAddressAuthentication", + "methods": null, + "description": "Contains authentication data for a email address", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "emailAddressAuthenticationCode", + "methods": [ + { + "name": "code", + "type": "string", + "description": "The code" + } + ], + "description": "An authentication code delivered to a user's email address", + "inheritance": "EmailAddressAuthentication", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "emailAddressAuthenticationAppleId", + "methods": [ + { + "name": "token", + "type": "string", + "description": "The token" + } + ], + "description": "An authentication token received through Apple ID", + "inheritance": "EmailAddressAuthentication", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "emailAddressAuthenticationGoogleId", + "methods": [ + { + "name": "token", + "type": "string", + "description": "The token" + } + ], + "description": "An authentication token received through Google ID", + "inheritance": "EmailAddressAuthentication", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "textEntity", "methods": [ @@ -283,7 +273,7 @@ { "name": "entities", "type": "vector", - "description": "Entities contained in the text. Entities can be nested, but must not mutually intersect with each other. Pre, Code and PreCode entities can't contain other entities. Bold, Italic, Underline and Strikethrough entities can contain and to be contained in all other entities. All other entities can't contain each other" + "description": "Entities contained in the text. Entities can be nested, but must not mutually intersect with each other. Pre, Code and PreCode entities can't contain other entities. Bold, Italic, Underline, Strikethrough, and Spoiler entities can contain and to be contained in all other entities. All other entities can't contain each other" } ], "description": "A text with some entities", @@ -303,7 +293,7 @@ { "name": "min_user_age", "type": "int32", - "description": "The minimum age of a user to be able to accept the terms; 0 if any" + "description": "The minimum age of a user to be able to accept the terms; 0 if age isn't restricted" }, { "name": "show_popup", @@ -329,22 +319,7 @@ { "name": "authorizationStateWaitTdlibParameters", "methods": null, - "description": "TDLib needs TdlibParameters for initialization", - "inheritance": "AuthorizationState", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "authorizationStateWaitEncryptionKey", - "methods": [ - { - "name": "is_encrypted", - "type": "Bool", - "description": "True, if the database is currently encrypted" - } - ], - "description": "TDLib needs an encryption key to decrypt the local database", + "description": "Initializetion parameters are needed. Call `setTdlibParameters` to provide them", "inheritance": "AuthorizationState", "return_type": "", "isFunction": false, @@ -359,6 +334,56 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "authorizationStateWaitEmailAddress", + "methods": [ + { + "name": "allow_apple_id", + "type": "Bool", + "description": "True, if authorization through Apple ID is allowed" + }, + { + "name": "allow_google_id", + "type": "Bool", + "description": "True, if authorization through Google ID is allowed" + } + ], + "description": "TDLib needs the user's email address to authorize. Call `setAuthenticationEmailAddress` to provide the email address, or directly call `checkAuthenticationEmailCode` with Apple ID/Google ID token if allowed", + "inheritance": "AuthorizationState", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "authorizationStateWaitEmailCode", + "methods": [ + { + "name": "allow_apple_id", + "type": "Bool", + "description": "True, if authorization through Apple ID is allowed" + }, + { + "name": "allow_google_id", + "type": "Bool", + "description": "True, if authorization through Google ID is allowed" + }, + { + "name": "code_info", + "type": "emailAddressAuthenticationCodeInfo", + "description": "Information about the sent authentication code" + }, + { + "name": "next_phone_number_authorization_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the user will be able to authorize with a code sent to the user's phone number; 0 if unknown" + } + ], + "description": "TDLib needs the user's authentication code sent to an email address to authorize. Call `checkAuthenticationEmailCode` to provide the code", + "inheritance": "AuthorizationState", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "authorizationStateWaitCode", "methods": [ @@ -423,7 +448,7 @@ "description": "Pattern of the email address to which the recovery email was sent; empty until a recovery email has been sent" } ], - "description": "The user has been authorized, but needs to enter a password to start using the application", + "description": "The user has been authorized, but needs to enter a 2-step verification password to start using the application", "inheritance": "AuthorizationState", "return_type": "", "isFunction": false, @@ -459,7 +484,7 @@ { "name": "authorizationStateClosed", "methods": null, - "description": "TDLib client is in its final state. All databases are closed and all resources are released. No other updates will be received after this. All queries will be responded to with error code 500. To continue working, one should create a new instance of the TDLib client", + "description": "TDLib client is in its final state. All databases are closed and all resources are released. No other updates will be received after this. All queries will be responded to with error code 500. To continue working, one must create a new instance of the TDLib client", "inheritance": "AuthorizationState", "return_type": "", "isFunction": false, @@ -492,6 +517,16 @@ "name": "recovery_email_address_code_info", "type": "emailAddressAuthenticationCodeInfo", "description": "Information about the recovery email address to which the confirmation email was sent; may be null" + }, + { + "name": "login_email_address_pattern", + "type": "string", + "description": "Pattern of the email address set up for logging in" + }, + { + "name": "pending_reset_date", + "type": "int32", + "description": "If not 0, point in time (Unix timestamp) after which the 2-step verification password can be reset immediately using resetPassword" } ], "description": "Represents the current state of 2-step verification", @@ -546,7 +581,7 @@ { "name": "can_be_downloaded", "type": "Bool", - "description": "True, if it is possible to try to download or generate the file" + "description": "True, if it is possible to download or generate the file" }, { "name": "can_be_deleted", @@ -565,18 +600,18 @@ }, { "name": "download_offset", - "type": "int32", + "type": "int53", "description": "Download will be started from this offset. downloaded_prefix_size is calculated from this offset" }, { "name": "downloaded_prefix_size", - "type": "int32", - "description": "If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix" + "type": "int53", + "description": "If is_downloading_completed is false, then only some prefix of the file starting from download_offset is ready to be read. downloaded_prefix_size is the size of that prefix in bytes" }, { "name": "downloaded_size", - "type": "int32", - "description": "Total downloaded file bytes. Should be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage" + "type": "int53", + "description": "Total downloaded file size, in bytes. Can be used only for calculating download progress. The actual file size may be bigger, and some parts of it may contain garbage" } ], "description": "Represents a local file", @@ -591,7 +626,7 @@ { "name": "id", "type": "string", - "description": "Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers. If the ID starts with \"http://\" or \"https://\", it represents the HTTP URL of the file. TDLib is currently unable to download files if only their URL is known. If downloadFile is called on such a file or if it is sent to a secret chat, TDLib starts a file generation process by sending updateFileGenerationStart to the application with the HTTP URL in the original_path and \"#url#\" as the conversion string. Application should generate the file by downloading it to the specified location" + "description": "Remote file identifier; may be empty. Can be used by the current user across application restarts or even from other devices. Uniquely identifies a file, but a file can have a lot of different valid identifiers. If the ID starts with \"http://\" or \"https://\", it represents the HTTP URL of the file. TDLib is currently unable to download files if only their URL is known. If downloadFile/addFileToDownloads is called on such a file or if it is sent to a secret chat, TDLib starts a file generation process by sending updateFileGenerationStart to the application with the HTTP URL in the original_path and \"#url#\" as the conversion string. Application must generate the file by downloading it to the specified location" }, { "name": "unique_id", @@ -610,8 +645,8 @@ }, { "name": "uploaded_size", - "type": "int32", - "description": "Size of the remote available part of the file; 0 if unknown" + "type": "int53", + "description": "Size of the remote available part of the file, in bytes; 0 if unknown" } ], "description": "Represents a remote file", @@ -630,13 +665,13 @@ }, { "name": "size", - "type": "int32", - "description": "File size; 0 if unknown" + "type": "int53", + "description": "File size, in bytes; 0 if unknown" }, { "name": "expected_size", - "type": "int32", - "description": "Expected file size in case the exact file size is unknown, but an approximate size is known. Can be used to show download/upload progress" + "type": "int53", + "description": "Approximate file size in bytes in case the exact file size is unknown. Can be used to show download/upload progress" }, { "name": "local", @@ -655,6 +690,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "files", + "methods": [ + { + "name": "files", + "type": "vector", + "description": "List of files" + } + ], + "description": "Represents a list of files", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "InputFile", "methods": null, @@ -720,12 +770,12 @@ { "name": "conversion", "type": "string", - "description": "String specifying the conversion applied to the original file; should be persistent across application restarts. Conversions beginning with '#' are reserved for internal TDLib usage" + "description": "String specifying the conversion applied to the original file; must be persistent across application restarts. Conversions beginning with '#' are reserved for internal TDLib usage" }, { "name": "expected_size", - "type": "int32", - "description": "Expected size of the generated file; 0 if unknown" + "type": "int53", + "description": "Expected size of the generated file, in bytes; 0 if unknown" } ], "description": "A file generated by the application", @@ -760,7 +810,7 @@ { "name": "progressive_sizes", "type": "vector", - "description": "Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image" + "description": "Sizes of progressive JPEG file prefixes, which can be used to preliminarily show the image; in bytes" } ], "description": "Describes an image in JPEG format", @@ -797,7 +847,7 @@ { "name": "ThumbnailFormat", "methods": null, - "description": "Describes format of the thumbnail", + "description": "Describes format of a thumbnail", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -812,24 +862,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "thumbnailFormatPng", - "methods": null, - "description": "The thumbnail is in PNG format. It will be used only for background patterns", - "inheritance": "ThumbnailFormat", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "thumbnailFormatWebp", - "methods": null, - "description": "The thumbnail is in WEBP format. It will be used only for some stickers", - "inheritance": "ThumbnailFormat", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "thumbnailFormatGif", "methods": null, @@ -840,18 +872,45 @@ "isSynchronous": false }, { - "name": "thumbnailFormatTgs", + "name": "thumbnailFormatMpeg4", "methods": null, - "description": "The thumbnail is in TGS format. It will be used only for animated sticker sets", + "description": "The thumbnail is in MPEG4 format. It will be used only for some animations and videos", "inheritance": "ThumbnailFormat", "return_type": "", "isFunction": false, "isSynchronous": false }, { - "name": "thumbnailFormatMpeg4", + "name": "thumbnailFormatPng", "methods": null, - "description": "The thumbnail is in MPEG4 format. It will be used only for some animations and videos", + "description": "The thumbnail is in PNG format. It will be used only for background patterns", + "inheritance": "ThumbnailFormat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "thumbnailFormatTgs", + "methods": null, + "description": "The thumbnail is in TGS format. It will be used only for TGS sticker sets", + "inheritance": "ThumbnailFormat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "thumbnailFormatWebm", + "methods": null, + "description": "The thumbnail is in WEBM format. It will be used only for WEBM sticker sets", + "inheritance": "ThumbnailFormat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "thumbnailFormatWebp", + "methods": null, + "description": "The thumbnail is in WEBP format. It will be used only for some stickers", "inheritance": "ThumbnailFormat", "return_type": "", "isFunction": false, @@ -890,7 +949,7 @@ { "name": "MaskPoint", "methods": null, - "description": "Part of the face, relative to which a mask should be placed", + "description": "Part of the face, relative to which a mask is placed", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -899,7 +958,7 @@ { "name": "maskPointForehead", "methods": null, - "description": "A mask should be placed relatively to the forehead", + "description": "The mask is placed relatively to the forehead", "inheritance": "MaskPoint", "return_type": "", "isFunction": false, @@ -908,7 +967,7 @@ { "name": "maskPointEyes", "methods": null, - "description": "A mask should be placed relatively to the eyes", + "description": "The mask is placed relatively to the eyes", "inheritance": "MaskPoint", "return_type": "", "isFunction": false, @@ -917,7 +976,7 @@ { "name": "maskPointMouth", "methods": null, - "description": "A mask should be placed relatively to the mouth", + "description": "The mask is placed relatively to the mouth", "inheritance": "MaskPoint", "return_type": "", "isFunction": false, @@ -926,7 +985,7 @@ { "name": "maskPointChin", "methods": null, - "description": "A mask should be placed relatively to the chin", + "description": "The mask is placed relatively to the chin", "inheritance": "MaskPoint", "return_type": "", "isFunction": false, @@ -938,7 +997,7 @@ { "name": "point", "type": "MaskPoint", - "description": "Part of the face, relative to which the mask should be placed" + "description": "Part of the face, relative to which the mask is placed" }, { "name": "x_shift", @@ -956,7 +1015,94 @@ "description": "Mask scaling coefficient. (For example, 2.0 means a doubled size)" } ], - "description": "Position on a photo where a mask should be placed", + "description": "Position on a photo where a mask is placed", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "StickerFormat", + "methods": null, + "description": "Describes format of a sticker", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "stickerFormatWebp", + "methods": null, + "description": "The sticker is an image in WEBP format", + "inheritance": "StickerFormat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "stickerFormatTgs", + "methods": null, + "description": "The sticker is an animation in TGS format", + "inheritance": "StickerFormat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "stickerFormatWebm", + "methods": null, + "description": "The sticker is a video in WEBM format", + "inheritance": "StickerFormat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "StickerType", + "methods": null, + "description": "Describes type of a sticker", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "stickerTypeRegular", + "methods": null, + "description": "The sticker is a regular sticker", + "inheritance": "StickerType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "stickerTypeMask", + "methods": null, + "description": "The sticker is a mask in WEBP format to be placed on photos or videos", + "inheritance": "StickerType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "stickerTypeCustomEmoji", + "methods": null, + "description": "The sticker is a custom emoji to be used inside message text and caption", + "inheritance": "StickerType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "closedVectorPath", + "methods": [ + { + "name": "commands", + "type": "vector", + "description": "List of vector path commands" + } + ], + "description": "Represents a closed vector path. The path begins at the end point of the last command", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -968,7 +1114,7 @@ { "name": "text", "type": "string", - "description": "Option text, 1-100 characters" + "description": "Option text; 1-100 characters" }, { "name": "voter_count", @@ -978,7 +1124,7 @@ { "name": "vote_percentage", "type": "int32", - "description": "The percentage of votes for this option, 0-100" + "description": "The percentage of votes for this option; 0-100" }, { "name": "is_chosen", @@ -1032,7 +1178,7 @@ { "name": "explanation", "type": "formattedText", - "description": "Text that is shown when the user chooses an incorrect answer or taps on the lamp icon, 0-200 characters with at most 2 line feeds; empty for a yet unanswered poll" + "description": "Text that is shown when the user chooses an incorrect answer or taps on the lamp icon; 0-200 characters with at most 2 line feeds; empty for a yet unanswered poll" } ], "description": "A poll in quiz mode, which has exactly one correct answer option and can be answered only once", @@ -1132,7 +1278,12 @@ { "name": "album_cover_thumbnail", "type": "thumbnail", - "description": "The thumbnail of the album cover in JPEG format; as defined by the sender. The full size thumbnail should be extracted from the downloaded file; may be null" + "description": "The thumbnail of the album cover in JPEG format; as defined by the sender. The full size thumbnail is supposed to be extracted from the downloaded audio file; may be null" + }, + { + "name": "external_album_covers", + "type": "vector", + "description": "Album cover variants to use if the downloaded audio file contains no album cover. Provided thumbnail dimensions are approximate" }, { "name": "audio", @@ -1230,25 +1381,45 @@ "description": "Emoji corresponding to the sticker" }, { - "name": "is_animated", - "type": "Bool", - "description": "True, if the sticker is an animated sticker in TGS format" + "name": "format", + "type": "StickerFormat", + "description": "Sticker format" }, { - "name": "is_mask", - "type": "Bool", - "description": "True, if the sticker is a mask" + "name": "type", + "type": "StickerType", + "description": "Sticker type" }, { "name": "mask_position", "type": "maskPosition", - "description": "Position where the mask should be placed; may be null" + "description": "Position where the mask is placed; may be null even the sticker is a mask" + }, + { + "name": "custom_emoji_id", + "type": "int64", + "description": "Identifier of the emoji if the sticker is a custom emoji" + }, + { + "name": "outline", + "type": "vector", + "description": "Sticker's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner" }, { "name": "thumbnail", "type": "thumbnail", "description": "Sticker thumbnail in WEBP or JPEG format; may be null" }, + { + "name": "is_premium", + "type": "Bool", + "description": "True, if only Premium users can use the sticker" + }, + { + "name": "premium_animation", + "type": "file", + "description": "Premium animation of the sticker; may be null" + }, { "name": "sticker", "type": "file", @@ -1297,7 +1468,7 @@ { "name": "supports_streaming", "type": "Bool", - "description": "True, if the video should be tried to be streamed" + "description": "True, if the video is supposed to be streamed" }, { "name": "minithumbnail", @@ -1374,6 +1545,11 @@ "type": "string", "description": "MIME type of the file; as defined by the sender" }, + { + "name": "speech_recognition_result", + "type": "SpeechRecognitionResult", + "description": "Result of speech recognition in the voice note; may be null" + }, { "name": "voice", "type": "file", @@ -1386,6 +1562,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "animatedEmoji", + "methods": [ + { + "name": "sticker", + "type": "sticker", + "description": "Sticker for the emoji; may be null if yet unknown for a custom emoji. If the sticker is a custom emoji, it can have arbitrary format different from stickerFormatTgs" + }, + { + "name": "fitzpatrick_type", + "type": "int32", + "description": "Emoji modifier fitzpatrick type; 0-6; 0 if none" + }, + { + "name": "sound", + "type": "file", + "description": "File containing the sound to be played when the sticker is clicked; may be null. The sound is encoded with the Opus codec, and stored inside an OGG container" + } + ], + "description": "Describes an animated or custom representation of an emoji", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "contact", "methods": [ @@ -1411,7 +1612,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user, if known; otherwise 0" } ], @@ -1433,6 +1634,11 @@ "name": "longitude", "type": "double", "description": "Longitude of the location, in degrees; as defined by the sender" + }, + { + "name": "horizontal_accuracy", + "type": "double", + "description": "The estimated horizontal accuracy of the location, in meters; as defined by the sender. 0 if unknown" } ], "description": "Describes a location on planet Earth", @@ -1462,7 +1668,7 @@ { "name": "provider", "type": "string", - "description": "Provider of the venue database; as defined by the sender. Currently only \"foursquare\" and \"gplaces\" (Google Places) need to be supported" + "description": "Provider of the venue database; as defined by the sender. Currently, only \"foursquare\" and \"gplaces\" (Google Places) need to be supported" }, { "name": "id", @@ -1537,7 +1743,7 @@ { "name": "question", "type": "string", - "description": "Poll question, 1-300 characters" + "description": "Poll question; 1-300 characters" }, { "name": "options", @@ -1551,7 +1757,7 @@ }, { "name": "recent_voter_user_ids", - "type": "vector", + "type": "vector", "description": "User identifiers of recent voters, if the poll is non-anonymous" }, { @@ -1572,7 +1778,7 @@ { "name": "close_date", "type": "int32", - "description": "Point in time (Unix timestamp) when the poll will be automatically closed" + "description": "Point in time (Unix timestamp) when the poll will automatically be closed" }, { "name": "is_closed", @@ -1604,6 +1810,11 @@ "type": "file", "description": "A big (640x640) user profile photo. The file can be downloaded only before the photo is changed" }, + { + "name": "minithumbnail", + "type": "minithumbnail", + "description": "User profile photo minithumbnail; may be null" + }, { "name": "has_animation", "type": "Bool", @@ -1629,6 +1840,11 @@ "type": "file", "description": "A big (640x640) chat photo variant in JPEG format. The file can be downloaded only before the photo is changed" }, + { + "name": "minithumbnail", + "type": "minithumbnail", + "description": "Chat photo minithumbnail; may be null" + }, { "name": "has_animation", "type": "Bool", @@ -1694,7 +1910,12 @@ { "name": "need_location", "type": "Bool", - "description": "True, if the location of the user should be sent with every inline query to this bot" + "description": "True, if the location of the user is expected to be sent with every inline query to this bot" + }, + { + "name": "can_be_added_to_attachment_menu", + "type": "Bool", + "description": "True, if the bot can be added to attachment menu" } ], "description": "A bot (see https://core.telegram.org/bots)", @@ -1733,20 +1954,40 @@ "isSynchronous": false }, { - "name": "botInfo", + "name": "botCommands", "methods": [ { - "name": "description", - "type": "string", - "description": "Long description shown on the user info page" + "name": "bot_user_id", + "type": "int53", + "description": "Bot's user identifier" }, { "name": "commands", "type": "vector", - "description": "A list of commands supported by the bot" + "description": "List of bot commands" } ], - "description": "Provides information about a bot and its supported commands", + "description": "Contains a list of bot commands", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botMenuButton", + "methods": [ + { + "name": "text", + "type": "string", + "description": "Text of the button" + }, + { + "name": "url", + "type": "string", + "description": "URL to be passed to openWebApp" + } + ], + "description": "Describes a button to be shown instead of bot commands menu button", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -1823,7 +2064,12 @@ { "name": "animation", "type": "animatedChatPhoto", - "description": "Animated variant of the photo in MPEG4 format; may be null" + "description": "A big (640x640) animated variant of the photo in MPEG4 format; may be null" + }, + { + "name": "small_animation", + "type": "animatedChatPhoto", + "description": "A small (160x160) animated variant of the photo in MPEG4 format; may be null even the big animation is available" } ], "description": "Describes a chat or user profile photo", @@ -1867,7 +2113,7 @@ { "name": "chat_photo_id", "type": "int64", - "description": "Identifier of the profile photo to reuse" + "description": "Identifier of the current user's profile photo to reuse" } ], "description": "A previously used profile photo of the current user", @@ -1911,211 +2157,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "user", - "methods": [ - { - "name": "id", - "type": "int32", - "description": "User identifier" - }, - { - "name": "first_name", - "type": "string", - "description": "First name of the user" - }, - { - "name": "last_name", - "type": "string", - "description": "Last name of the user" - }, - { - "name": "username", - "type": "string", - "description": "Username of the user" - }, - { - "name": "phone_number", - "type": "string", - "description": "Phone number of the user" - }, - { - "name": "status", - "type": "UserStatus", - "description": "Current online status of the user" - }, - { - "name": "profile_photo", - "type": "profilePhoto", - "description": "Profile photo of the user; may be null" - }, - { - "name": "is_contact", - "type": "Bool", - "description": "The user is a contact of the current user" - }, - { - "name": "is_mutual_contact", - "type": "Bool", - "description": "The user is a contact of the current user and the current user is a contact of the user" - }, - { - "name": "is_verified", - "type": "Bool", - "description": "True, if the user is verified" - }, - { - "name": "is_support", - "type": "Bool", - "description": "True, if the user is Telegram support account" - }, - { - "name": "restriction_reason", - "type": "string", - "description": "If non-empty, it contains a human-readable description of the reason why access to this user must be restricted" - }, - { - "name": "is_scam", - "type": "Bool", - "description": "True, if many users reported this user as a scam" - }, - { - "name": "have_access", - "type": "Bool", - "description": "If false, the user is inaccessible, and the only information known about the user is inside this class. It can't be passed to any method except GetUser" - }, - { - "name": "type", - "type": "UserType", - "description": "Type of the user" - }, - { - "name": "language_code", - "type": "string", - "description": "IETF language tag of the user's language; only available to bots" - } - ], - "description": "Represents a user", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "userFullInfo", - "methods": [ - { - "name": "photo", - "type": "chatPhoto", - "description": "User profile photo; may be null" - }, - { - "name": "can_be_called", - "type": "Bool", - "description": "True, if the user can be called" - }, - { - "name": "supports_video_calls", - "type": "Bool", - "description": "True, if a video call can be created with the user" - }, - { - "name": "has_private_calls", - "type": "Bool", - "description": "True, if the user can't be called due to their privacy settings" - }, - { - "name": "need_phone_number_privacy_exception", - "type": "Bool", - "description": "True, if the current user needs to explicitly allow to share their phone number with the user when the method addContact is used" - }, - { - "name": "bio", - "type": "string", - "description": "A short user bio" - }, - { - "name": "share_text", - "type": "string", - "description": "For bots, the text that is included with the link when users share the bot" - }, - { - "name": "group_in_common_count", - "type": "int32", - "description": "Number of group chats where both the other user and the current user are a member; 0 for the current user" - }, - { - "name": "bot_info", - "type": "botInfo", - "description": "If the user is a bot, information about the bot; may be null" - } - ], - "description": "Contains full information about a user", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "users", - "methods": [ - { - "name": "total_count", - "type": "int32", - "description": "Approximate total count of users found" - }, - { - "name": "user_ids", - "type": "vector", - "description": "A list of user identifiers" - } - ], - "description": "Represents a list of users", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatAdministrator", - "methods": [ - { - "name": "user_id", - "type": "int32", - "description": "User identifier of the administrator" - }, - { - "name": "custom_title", - "type": "string", - "description": "Custom title of the administrator" - }, - { - "name": "is_owner", - "type": "Bool", - "description": "True, if the user is the owner of the chat" - } - ], - "description": "Contains information about a chat administrator", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatAdministrators", - "methods": [ - { - "name": "administrators", - "type": "vector", - "description": "A list of chat administrators" - } - ], - "description": "Represents a list of chat administrators", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "chatPermissions", "methods": [ @@ -2167,51 +2208,12 @@ "isSynchronous": false }, { - "name": "ChatMemberStatus", - "methods": null, - "description": "Provides information about the status of a member in a chat", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatMemberStatusCreator", + "name": "chatAdministratorRights", "methods": [ { - "name": "custom_title", - "type": "string", - "description": "A custom title of the owner; 0-16 characters without emojis; applicable to supergroups only" - }, - { - "name": "is_anonymous", + "name": "can_manage_chat", "type": "Bool", - "description": "True, if the creator isn't shown in the chat member list and sends messages anonymously" - }, - { - "name": "is_member", - "type": "Bool", - "description": "True, if the user is a member of the chat" - } - ], - "description": "The user is the owner of a chat and has all the administrator privileges", - "inheritance": "ChatMemberStatus", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatMemberStatusAdministrator", - "methods": [ - { - "name": "custom_title", - "type": "string", - "description": "A custom title of the administrator; 0-16 characters without emojis; applicable to supergroups only" - }, - { - "name": "can_be_edited", - "type": "Bool", - "description": "True, if the current user can edit the administrator privileges for the called user" + "description": "True, if the administrator can get chat event log, get chat statistics, get message statistics in channels, get channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other privilege; applicable to supergroups and channels only" }, { "name": "can_change_info", @@ -2241,25 +2243,449 @@ { "name": "can_restrict_members", "type": "Bool", - "description": "True, if the administrator can restrict, ban, or unban chat members" + "description": "True, if the administrator can restrict, ban, or unban chat members; always true for channels" }, { "name": "can_pin_messages", "type": "Bool", - "description": "True, if the administrator can pin messages; applicable to groups only" + "description": "True, if the administrator can pin messages; applicable to basic groups and supergroups only" }, { "name": "can_promote_members", "type": "Bool", "description": "True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that were directly or indirectly promoted by them" }, + { + "name": "can_manage_video_chats", + "type": "Bool", + "description": "True, if the administrator can manage video chats" + }, { "name": "is_anonymous", "type": "Bool", - "description": "True, if the administrator isn't shown in the chat member list and sends messages anonymously" + "description": "True, if the administrator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only" } ], - "description": "The user is a member of a chat and has some additional privileges. In basic groups, administrators can edit and delete messages sent by others, add new members, and ban unprivileged members. In supergroups and channels, there are more detailed options for administrator privileges", + "description": "Describes rights of the administrator", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumPaymentOption", + "methods": [ + { + "name": "currency", + "type": "string", + "description": "ISO 4217 currency code for Telegram Premium subscription payment" + }, + { + "name": "amount", + "type": "int53", + "description": "The amount to pay, in the smallest units of the currency" + }, + { + "name": "discount_percentage", + "type": "int32", + "description": "The discount associated with this option, as a percentage" + }, + { + "name": "month_count", + "type": "int32", + "description": "Number of month the Telegram Premium subscription will be active" + }, + { + "name": "store_product_id", + "type": "string", + "description": "Identifier of the store product associated with the option" + }, + { + "name": "payment_link", + "type": "InternalLinkType", + "description": "An internal link to be opened for buying Telegram Premium to the user if store payment isn't possible; may be null if direct payment isn't available" + } + ], + "description": "Describes an option for buying Telegram Premium to a user", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "emojiStatus", + "methods": [ + { + "name": "custom_emoji_id", + "type": "int64", + "description": "Identifier of the custom emoji in stickerFormatTgs format. If the custom emoji belongs to the sticker set GetOption(\"themed_emoji_statuses_sticker_set_id\"), then it's color must be changed to the color of the Telegram Premium badge" + } + ], + "description": "Describes a custom emoji to be shown instead of the Telegram Premium badge", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "emojiStatuses", + "methods": [ + { + "name": "emoji_statuses", + "type": "vector", + "description": "The list of emoji statuses" + } + ], + "description": "Contains a list of emoji statuses", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "user", + "methods": [ + { + "name": "id", + "type": "int53", + "description": "User identifier" + }, + { + "name": "first_name", + "type": "string", + "description": "First name of the user" + }, + { + "name": "last_name", + "type": "string", + "description": "Last name of the user" + }, + { + "name": "username", + "type": "string", + "description": "Username of the user" + }, + { + "name": "phone_number", + "type": "string", + "description": "Phone number of the user" + }, + { + "name": "status", + "type": "UserStatus", + "description": "Current online status of the user" + }, + { + "name": "profile_photo", + "type": "profilePhoto", + "description": "Profile photo of the user; may be null" + }, + { + "name": "emoji_status", + "type": "emojiStatus", + "description": "Emoji status to be shown instead of the default Telegram Premium badge; may be null. For Telegram Premium users only" + }, + { + "name": "is_contact", + "type": "Bool", + "description": "The user is a contact of the current user" + }, + { + "name": "is_mutual_contact", + "type": "Bool", + "description": "The user is a contact of the current user and the current user is a contact of the user" + }, + { + "name": "is_verified", + "type": "Bool", + "description": "True, if the user is verified" + }, + { + "name": "is_premium", + "type": "Bool", + "description": "True, if the user is a Telegram Premium user" + }, + { + "name": "is_support", + "type": "Bool", + "description": "True, if the user is Telegram support account" + }, + { + "name": "restriction_reason", + "type": "string", + "description": "If non-empty, it contains a human-readable description of the reason why access to this user must be restricted" + }, + { + "name": "is_scam", + "type": "Bool", + "description": "True, if many users reported this user as a scam" + }, + { + "name": "is_fake", + "type": "Bool", + "description": "True, if many users reported this user as a fake account" + }, + { + "name": "have_access", + "type": "Bool", + "description": "If false, the user is inaccessible, and the only information known about the user is inside this class. Identifier of the user can't be passed to any method except GetUser" + }, + { + "name": "type", + "type": "UserType", + "description": "Type of the user" + }, + { + "name": "language_code", + "type": "string", + "description": "IETF language tag of the user's language; only available to bots" + }, + { + "name": "added_to_attachment_menu", + "type": "Bool", + "description": "True, if the user added the current bot to attachment menu; only available to bots" + } + ], + "description": "Represents a user", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botInfo", + "methods": [ + { + "name": "share_text", + "type": "string", + "description": "The text that is shown on the bot's profile page and is sent together with the link when users share the bot" + }, + { + "name": "description", + "type": "string", + "description": "The text shown in the chat with the bot if the chat is empty" + }, + { + "name": "photo", + "type": "photo", + "description": "Photo shown in the chat with the bot if the chat is empty; may be null" + }, + { + "name": "animation", + "type": "animation", + "description": "Animation shown in the chat with the bot if the chat is empty; may be null" + }, + { + "name": "menu_button", + "type": "botMenuButton", + "description": "Information about a button to show instead of the bot commands menu button; may be null if ordinary bot commands menu must be shown" + }, + { + "name": "commands", + "type": "vector", + "description": "List of the bot commands" + }, + { + "name": "default_group_administrator_rights", + "type": "chatAdministratorRights", + "description": "Default administrator rights for adding the bot to basic group and supergroup chats; may be null" + }, + { + "name": "default_channel_administrator_rights", + "type": "chatAdministratorRights", + "description": "Default administrator rights for adding the bot to channels; may be null" + } + ], + "description": "Contains information about a bot", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "userFullInfo", + "methods": [ + { + "name": "photo", + "type": "chatPhoto", + "description": "User profile photo; may be null" + }, + { + "name": "is_blocked", + "type": "Bool", + "description": "True, if the user is blocked by the current user" + }, + { + "name": "can_be_called", + "type": "Bool", + "description": "True, if the user can be called" + }, + { + "name": "supports_video_calls", + "type": "Bool", + "description": "True, if a video call can be created with the user" + }, + { + "name": "has_private_calls", + "type": "Bool", + "description": "True, if the user can't be called due to their privacy settings" + }, + { + "name": "has_private_forwards", + "type": "Bool", + "description": "True, if the user can't be linked in forwarded messages due to their privacy settings" + }, + { + "name": "has_restricted_voice_and_video_note_messages", + "type": "Bool", + "description": "True, if voice and video notes can't be sent or forwarded to the user" + }, + { + "name": "need_phone_number_privacy_exception", + "type": "Bool", + "description": "True, if the current user needs to explicitly allow to share their phone number with the user when the method addContact is used" + }, + { + "name": "bio", + "type": "formattedText", + "description": "A short user bio; may be null for bots" + }, + { + "name": "premium_gift_options", + "type": "vector", + "description": "The list of available options for gifting Telegram Premium to the user" + }, + { + "name": "group_in_common_count", + "type": "int32", + "description": "Number of group chats where both the other user and the current user are a member; 0 for the current user" + }, + { + "name": "bot_info", + "type": "botInfo", + "description": "For bots, information about the bot; may be null" + } + ], + "description": "Contains full information about a user", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "users", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Approximate total number of users found" + }, + { + "name": "user_ids", + "type": "vector", + "description": "A list of user identifiers" + } + ], + "description": "Represents a list of users", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatAdministrator", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "User identifier of the administrator" + }, + { + "name": "custom_title", + "type": "string", + "description": "Custom title of the administrator" + }, + { + "name": "is_owner", + "type": "Bool", + "description": "True, if the user is the owner of the chat" + } + ], + "description": "Contains information about a chat administrator", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatAdministrators", + "methods": [ + { + "name": "administrators", + "type": "vector", + "description": "A list of chat administrators" + } + ], + "description": "Represents a list of chat administrators", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "ChatMemberStatus", + "methods": null, + "description": "Provides information about the status of a member in a chat", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatMemberStatusCreator", + "methods": [ + { + "name": "custom_title", + "type": "string", + "description": "A custom title of the owner; 0-16 characters without emojis; applicable to supergroups only" + }, + { + "name": "is_anonymous", + "type": "Bool", + "description": "True, if the creator isn't shown in the chat member list and sends messages anonymously; applicable to supergroups only" + }, + { + "name": "is_member", + "type": "Bool", + "description": "True, if the user is a member of the chat" + } + ], + "description": "The user is the owner of the chat and has all the administrator privileges", + "inheritance": "ChatMemberStatus", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatMemberStatusAdministrator", + "methods": [ + { + "name": "custom_title", + "type": "string", + "description": "A custom title of the administrator; 0-16 characters without emojis; applicable to supergroups only" + }, + { + "name": "can_be_edited", + "type": "Bool", + "description": "True, if the current user can edit the administrator privileges for the called user" + }, + { + "name": "rights", + "type": "chatAdministratorRights", + "description": "Rights of the administrator" + } + ], + "description": "The user is a member of the chat and has some additional privileges. In basic groups, administrators can edit and delete messages sent by others, add new members, ban unprivileged members, and manage video chats. In supergroups and channels, there are more detailed options for administrator privileges", "inheritance": "ChatMemberStatus", "return_type": "", "isFunction": false, @@ -2268,7 +2694,7 @@ { "name": "chatMemberStatusMember", "methods": null, - "description": "The user is a member of a chat, without any additional privileges or restrictions", + "description": "The user is a member of the chat, without any additional privileges or restrictions", "inheritance": "ChatMemberStatus", "return_type": "", "isFunction": false, @@ -2302,7 +2728,7 @@ { "name": "chatMemberStatusLeft", "methods": null, - "description": "The user is not a chat member", + "description": "The user or the chat is not a chat member", "inheritance": "ChatMemberStatus", "return_type": "", "isFunction": false, @@ -2314,10 +2740,10 @@ { "name": "banned_until_date", "type": "int32", - "description": "Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever" + "description": "Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Always 0 in basic groups" } ], - "description": "The user was banned (and hence is not a member of the chat). Implies the user can't return to the chat or view messages", + "description": "The user or the chat was banned (and hence is not a member of the chat). Implies the user can't return to the chat, view messages, or be used as a participant identifier to join a video chat of the chat", "inheritance": "ChatMemberStatus", "return_type": "", "isFunction": false, @@ -2327,13 +2753,13 @@ "name": "chatMember", "methods": [ { - "name": "user_id", - "type": "int32", - "description": "User identifier of the chat member" + "name": "member_id", + "type": "MessageSender", + "description": "Identifier of the chat member. Currently, other chats can be only Left or Banned. Only supergroups and channels can have other chats as Left or Banned members and these chats must be supergroups or channels" }, { "name": "inviter_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of a user that invited/promoted/banned this member in the chat; 0 if unknown" }, { @@ -2345,14 +2771,9 @@ "name": "status", "type": "ChatMemberStatus", "description": "Status of the member in the chat" - }, - { - "name": "bot_info", - "type": "botInfo", - "description": "If the user is a bot, information about the bot; may be null. Can be null even for a bot if the bot is not the chat member" } ], - "description": "A user with information about joining/leaving a chat", + "description": "Describes a user or a chat as a member of another chat", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -2364,7 +2785,7 @@ { "name": "total_count", "type": "int32", - "description": "Approximate total count of chat members found" + "description": "Approximate total number of chat members found" }, { "name": "members", @@ -2414,6 +2835,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatMembersFilterMention", + "methods": [ + { + "name": "message_thread_id", + "type": "int53", + "description": "If non-zero, the identifier of the current message thread" + } + ], + "description": "Returns users which can be mentioned in the chat", + "inheritance": "ChatMembersFilter", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatMembersFilterRestricted", "methods": null, @@ -2528,6 +2964,26 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "supergroupMembersFilterMention", + "methods": [ + { + "name": "query", + "type": "string", + "description": "Query to search for" + }, + { + "name": "message_thread_id", + "type": "int53", + "description": "If non-zero, the identifier of the current message thread" + } + ], + "description": "Returns users which can be mentioned in the supergroup", + "inheritance": "SupergroupMembersFilter", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "supergroupMembersFilterBots", "methods": null, @@ -2537,12 +2993,312 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatInviteLink", + "methods": [ + { + "name": "invite_link", + "type": "string", + "description": "Chat invite link" + }, + { + "name": "name", + "type": "string", + "description": "Name of the link" + }, + { + "name": "creator_user_id", + "type": "int53", + "description": "User identifier of an administrator created the link" + }, + { + "name": "date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the link was created" + }, + { + "name": "edit_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown" + }, + { + "name": "expiration_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the link will expire; 0 if never" + }, + { + "name": "member_limit", + "type": "int32", + "description": "The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval" + }, + { + "name": "member_count", + "type": "int32", + "description": "Number of chat members, which joined the chat using the link" + }, + { + "name": "pending_join_request_count", + "type": "int32", + "description": "Number of pending join requests created using this link" + }, + { + "name": "creates_join_request", + "type": "Bool", + "description": "True, if the link only creates join request. If true, total number of joining members will be unlimited" + }, + { + "name": "is_primary", + "type": "Bool", + "description": "True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time" + }, + { + "name": "is_revoked", + "type": "Bool", + "description": "True, if the link was revoked" + } + ], + "description": "Contains a chat invite link", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatInviteLinks", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Approximate total number of chat invite links found" + }, + { + "name": "invite_links", + "type": "vector", + "description": "List of invite links" + } + ], + "description": "Contains a list of chat invite links", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatInviteLinkCount", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "Administrator's user identifier" + }, + { + "name": "invite_link_count", + "type": "int32", + "description": "Number of active invite links" + }, + { + "name": "revoked_invite_link_count", + "type": "int32", + "description": "Number of revoked invite links" + } + ], + "description": "Describes a chat administrator with a number of active and revoked chat invite links", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatInviteLinkCounts", + "methods": [ + { + "name": "invite_link_counts", + "type": "vector", + "description": "List of invite link counts" + } + ], + "description": "Contains a list of chat invite link counts", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatInviteLinkMember", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "User identifier" + }, + { + "name": "joined_chat_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the user joined the chat" + }, + { + "name": "approver_user_id", + "type": "int53", + "description": "User identifier of the chat administrator, approved user join request" + } + ], + "description": "Describes a chat member joined a chat via an invite link", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatInviteLinkMembers", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Approximate total number of chat members found" + }, + { + "name": "members", + "type": "vector", + "description": "List of chat members, joined a chat via an invite link" + } + ], + "description": "Contains a list of chat members joined a chat via an invite link", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatInviteLinkInfo", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier of the invite link; 0 if the user has no access to the chat before joining" + }, + { + "name": "accessible_for", + "type": "int32", + "description": "If non-zero, the amount of time for which read access to the chat will remain available, in seconds" + }, + { + "name": "type", + "type": "ChatType", + "description": "Type of the chat" + }, + { + "name": "title", + "type": "string", + "description": "Title of the chat" + }, + { + "name": "photo", + "type": "chatPhotoInfo", + "description": "Chat photo; may be null" + }, + { + "name": "description", + "type": "string", + "description": "Chat description" + }, + { + "name": "member_count", + "type": "int32", + "description": "Number of members in the chat" + }, + { + "name": "member_user_ids", + "type": "vector", + "description": "User identifiers of some chat members that may be known to the current user" + }, + { + "name": "creates_join_request", + "type": "Bool", + "description": "True, if the link only creates join request" + }, + { + "name": "is_public", + "type": "Bool", + "description": "True, if the chat is a public supergroup or channel, i.e. it has a username or it is a location-based supergroup" + } + ], + "description": "Contains information about a chat invite link", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatJoinRequest", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "User identifier" + }, + { + "name": "date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the user sent the join request" + }, + { + "name": "bio", + "type": "string", + "description": "A short bio of the user" + } + ], + "description": "Describes a user that sent a join request and waits for administrator approval", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatJoinRequests", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Approximate total number of requests found" + }, + { + "name": "requests", + "type": "vector", + "description": "List of the requests" + } + ], + "description": "Contains a list of requests to join a chat", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatJoinRequestsInfo", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Total number of pending join requests" + }, + { + "name": "user_ids", + "type": "vector", + "description": "Identifiers of at most 3 users sent the newest pending join requests" + } + ], + "description": "Contains information about pending join requests for a chat", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "basicGroup", "methods": [ { "name": "id", - "type": "int32", + "type": "int53", "description": "Group identifier" }, { @@ -2562,7 +3318,7 @@ }, { "name": "upgraded_to_supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the supergroup to which this group was upgraded; 0 if none" } ], @@ -2583,11 +3339,11 @@ { "name": "description", "type": "string", - "description": "Group description" + "description": "Group description. Updated only after the basic group is opened" }, { "name": "creator_user_id", - "type": "int32", + "type": "int53", "description": "User identifier of the creator of the group; 0 if unknown" }, { @@ -2597,8 +3353,13 @@ }, { "name": "invite_link", - "type": "string", - "description": "Invite link for this group; available only after it has been generated at least once and only for the group creator" + "type": "chatInviteLink", + "description": "Primary invite link for this group; may be null. For chat administrators with can_invite_users right only. Updated only after the basic group is opened" + }, + { + "name": "bot_commands", + "type": "vector", + "description": "List of commands of bots in the group" } ], "description": "Contains full information about a basic group", @@ -2612,7 +3373,7 @@ "methods": [ { "name": "id", - "type": "int32", + "type": "int53", "description": "Supergroup or channel identifier" }, { @@ -2633,7 +3394,7 @@ { "name": "member_count", "type": "int32", - "description": "Number of members in the supergroup or channel; 0 if unknown. Currently it is guaranteed to be known only if the supergroup or channel was received through searchPublicChats, searchChatsNearby, getInactiveSupergroupChats, getSuitableDiscussionChats, getGroupsInCommon, or getUserPrivacySettingRules" + "description": "Number of members in the supergroup or channel; 0 if unknown. Currently, it is guaranteed to be known only if the supergroup or channel was received through searchPublicChats, searchChatsNearby, getInactiveSupergroupChats, getSuitableDiscussionChats, getGroupsInCommon, or getUserPrivacySettingRules" }, { "name": "has_linked_chat", @@ -2648,7 +3409,17 @@ { "name": "sign_messages", "type": "Bool", - "description": "True, if messages sent to the channel should contain information about the sender. This field is only applicable to channels" + "description": "True, if messages sent to the channel need to contain information about the sender. This field is only applicable to channels" + }, + { + "name": "join_to_send_messages", + "type": "Bool", + "description": "True, if users need to join the supergroup before they can send messages. Always true for channels and non-discussion supergroups" + }, + { + "name": "join_by_request", + "type": "Bool", + "description": "True, if all users directly joining the supergroup need to be approved by supergroup administrators. Always false for channels and supergroups without username, location, or a linked chat" }, { "name": "is_slow_mode_enabled", @@ -2660,6 +3431,11 @@ "type": "Bool", "description": "True, if the supergroup is a channel" }, + { + "name": "is_broadcast_group", + "type": "Bool", + "description": "True, if the supergroup is a broadcast group, i.e. only administrators can send messages and there is no limit on the number of members" + }, { "name": "is_verified", "type": "Bool", @@ -2673,7 +3449,12 @@ { "name": "is_scam", "type": "Bool", - "description": "True, if many users reported this supergroup as a scam" + "description": "True, if many users reported this supergroup or channel as a scam" + }, + { + "name": "is_fake", + "type": "Bool", + "description": "True, if many users reported this supergroup or channel as a fake account" } ], "description": "Represents a supergroup or channel with zero or more members (subscribers in the case of channels). From the point of view of the system, a channel is a special kind of a supergroup: only administrators can post and see the list of members, and posts from all administrators use the name and photo of the channel instead of individual names and profile photos. Unlike supergroups, channels can have an unlimited number of subscribers", @@ -2772,12 +3553,17 @@ }, { "name": "invite_link", - "type": "string", - "description": "Invite link for this chat" + "type": "chatInviteLink", + "description": "Primary invite link for the chat; may be null. For chat administrators with can_invite_users right only" + }, + { + "name": "bot_commands", + "type": "vector", + "description": "List of commands of bots in the group" }, { "name": "upgraded_from_basic_group_id", - "type": "int32", + "type": "int53", "description": "Identifier of the basic group from which supergroup was upgraded; 0 if none" }, { @@ -2838,7 +3624,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the chat partner" }, { @@ -2851,11 +3637,6 @@ "type": "Bool", "description": "True, if the chat was created by the current user; otherwise false" }, - { - "name": "ttl", - "type": "int32", - "description": "Current message Time To Live setting (self-destruct timer) for the chat, in seconds" - }, { "name": "key_hash", "type": "bytes", @@ -2864,7 +3645,7 @@ { "name": "layer", "type": "int32", - "description": "Secret chat layer; determines features supported by the chat partner's application. Video notes are supported if the layer >= 66; nested text entities and underline and strikethrough entities are supported if the layer >= 101" + "description": "Secret chat layer; determines features supported by the chat partner's application. Nested text entities and underline and strikethrough entities are supported if the layer >= 101, files bigger than 2000MB are supported if the layer >= 143, spoiler and custom emoji text entities are supported if the layer >= 144" } ], "description": "Represents a secret chat", @@ -2873,6 +3654,65 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "MessageSender", + "methods": null, + "description": "Contains information about the sender of a message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageSenderUser", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "Identifier of the user that sent the message" + } + ], + "description": "The message was sent by a known user", + "inheritance": "MessageSender", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageSenderChat", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat that sent the message" + } + ], + "description": "The message was sent on behalf of a chat", + "inheritance": "MessageSender", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageSenders", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Approximate total number of messages senders found" + }, + { + "name": "senders", + "type": "vector", + "description": "List of message senders" + } + ], + "description": "Represents a list of message senders", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "MessageForwardOrigin", "methods": null, @@ -2887,11 +3727,11 @@ "methods": [ { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user that originally sent the message" } ], - "description": "The message was originally written by a known user", + "description": "The message was originally sent by a known user", "inheritance": "MessageForwardOrigin", "return_type": "", "isFunction": false, @@ -2904,9 +3744,14 @@ "name": "sender_chat_id", "type": "int53", "description": "Identifier of the chat that originally sent the message" + }, + { + "name": "author_signature", + "type": "string", + "description": "For messages originally sent by an anonymous chat administrator, original message author signature" } ], - "description": "The message was originally written by an anonymous chat administrator on behalf of the chat", + "description": "The message was originally sent on behalf of a chat", "inheritance": "MessageForwardOrigin", "return_type": "", "isFunction": false, @@ -2921,7 +3766,7 @@ "description": "Name of the sender" } ], - "description": "The message was originally written by a user, which is hidden by their privacy settings", + "description": "The message was originally sent by a user, which is hidden by their privacy settings", "inheritance": "MessageForwardOrigin", "return_type": "", "isFunction": false, @@ -2938,7 +3783,7 @@ { "name": "message_id", "type": "int53", - "description": "Message identifier of the original message; 0 if unknown" + "description": "Message identifier of the original message" }, { "name": "author_signature", @@ -2952,6 +3797,60 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageForwardOriginMessageImport", + "methods": [ + { + "name": "sender_name", + "type": "string", + "description": "Name of the sender" + } + ], + "description": "The message was imported from an exported message history", + "inheritance": "MessageForwardOrigin", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "ReactionType", + "methods": null, + "description": "Describes type of message reaction", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "reactionTypeEmoji", + "methods": [ + { + "name": "emoji", + "type": "string", + "description": "Text representation of the reaction" + } + ], + "description": "A reaction with an emoji", + "inheritance": "ReactionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "reactionTypeCustomEmoji", + "methods": [ + { + "name": "custom_emoji_id", + "type": "int64", + "description": "Unique identifier of the custom emoji" + } + ], + "description": "A reaction with a custom emoji", + "inheritance": "ReactionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageForwardInfo", "methods": [ @@ -2996,9 +3895,9 @@ "description": "Number of times the message was directly or indirectly replied" }, { - "name": "recent_replier_user_ids", - "type": "vector", - "description": "User identifiers of the recent repliers to the message; available in channels with a discussion supergroup" + "name": "recent_replier_ids", + "type": "vector", + "description": "Identifiers of at most 3 recent repliers to the message; available in channels with a discussion supergroup. The users and chats are expected to be inaccessible: only their photo and name will be available" }, { "name": "last_read_inbox_message_id", @@ -3016,7 +3915,37 @@ "description": "Identifier of the last reply to the message" } ], - "description": "Contains information about message replies", + "description": "Contains information about replies to a message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageReaction", + "methods": [ + { + "name": "type", + "type": "ReactionType", + "description": "Type of the reaction" + }, + { + "name": "total_count", + "type": "int32", + "description": "Number of times the reaction was added" + }, + { + "name": "is_chosen", + "type": "Bool", + "description": "True, if the reaction is chosen by the current user" + }, + { + "name": "recent_sender_ids", + "type": "vector", + "description": "Identifiers of at most 3 recent message senders, added the reaction; available in private, basic group and supergroup chats" + } + ], + "description": "Contains information about a reaction to a message", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -3038,7 +3967,12 @@ { "name": "reply_info", "type": "messageReplyInfo", - "description": "Contains information about direct or indirect replies to the message; may be null. Currently, available only in channels with a discussion supergroup and discussion supergroups for messages, which are not replies itself" + "description": "Information about direct or indirect replies to the message; may be null. Currently, available only in channels with a discussion supergroup and discussion supergroups for messages, which are not replies itself" + }, + { + "name": "reactions", + "type": "vector", + "description": "The list of reactions added to the message" } ], "description": "Contains information about interactions with a message", @@ -3047,6 +3981,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "unreadReaction", + "methods": [ + { + "name": "type", + "type": "ReactionType", + "description": "Type of the reaction" + }, + { + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender, added the reaction" + }, + { + "name": "is_big", + "type": "Bool", + "description": "True, if the reaction was added with a big animation" + } + ], + "description": "Contains information about an unread reaction to a message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "MessageSendingState", "methods": null, @@ -3083,6 +4042,11 @@ "type": "Bool", "description": "True, if the message can be re-sent" }, + { + "name": "need_another_sender", + "type": "Bool", + "description": "True, if the message can be re-sent only on behalf of a different sender" + }, { "name": "retry_after", "type": "double", @@ -3104,14 +4068,9 @@ "description": "Message identifier; unique for the chat to which the message belongs" }, { - "name": "sender_user_id", - "type": "int32", - "description": "Identifier of the user who sent the message; 0 if unknown. Currently, it is unknown for channel posts, for channel posts automatically forwarded to discussion group and for anonymously sent supergroup messages" - }, - { - "name": "sender_chat_id", - "type": "int53", - "description": "Identifier of the chat on behalf of which the message was sent; 0 if none" + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender of the message" }, { "name": "chat_id", @@ -3121,18 +4080,23 @@ { "name": "sending_state", "type": "MessageSendingState", - "description": "Information about the sending state of the message; may be null" + "description": "The sending state of the message; may be null" }, { "name": "scheduling_state", "type": "MessageSchedulingState", - "description": "Information about the scheduling state of the message; may be null" + "description": "The scheduling state of the message; may be null" }, { "name": "is_outgoing", "type": "Bool", "description": "True, if the message is outgoing" }, + { + "name": "is_pinned", + "type": "Bool", + "description": "True, if the message is pinned" + }, { "name": "can_be_edited", "type": "Bool", @@ -3143,6 +4107,11 @@ "type": "Bool", "description": "True, if the message can be forwarded" }, + { + "name": "can_be_saved", + "type": "Bool", + "description": "True, if content of the message can be saved locally or copied" + }, { "name": "can_be_deleted_only_for_self", "type": "Bool", @@ -3153,15 +4122,40 @@ "type": "Bool", "description": "True, if the message can be deleted for all users" }, + { + "name": "can_get_added_reactions", + "type": "Bool", + "description": "True, if the list of added reactions is available through getMessageAddedReactions" + }, { "name": "can_get_statistics", "type": "Bool", - "description": "True, if the message statistics are available" + "description": "True, if the message statistics are available through getMessageStatistics" }, { "name": "can_get_message_thread", "type": "Bool", - "description": "True, if the message thread info is available" + "description": "True, if information about the message thread is available through getMessageThread and getMessageThreadHistory" + }, + { + "name": "can_get_viewers", + "type": "Bool", + "description": "True, if chat members already viewed the message can be received through getMessageViewers" + }, + { + "name": "can_get_media_timestamp_links", + "type": "Bool", + "description": "True, if media timestamp links can be generated for media timestamp entities in the message text, caption or web page description through getMessageLink" + }, + { + "name": "can_report_reactions", + "type": "Bool", + "description": "True, if reactions on the message can be reported through reportMessageReactions" + }, + { + "name": "has_timestamped_media", + "type": "Bool", + "description": "True, if media timestamp entities refers to a media in this message as opposed to a media in the replied message" }, { "name": "is_channel_post", @@ -3193,6 +4187,11 @@ "type": "messageInteractionInfo", "description": "Information about interactions with the message; may be null" }, + { + "name": "unread_reactions", + "type": "vector", + "description": "Information about unread reactions added to the message" + }, { "name": "reply_in_chat_id", "type": "int53", @@ -3216,22 +4215,22 @@ { "name": "ttl_expires_in", "type": "double", - "description": "Time left before the message expires, in seconds" + "description": "Time left before the message expires, in seconds. If the TTL timer isn't started yet, equals to the value of the ttl field" }, { "name": "via_bot_user_id", - "type": "int32", + "type": "int53", "description": "If non-zero, the user identifier of the bot through which this message was sent" }, { "name": "author_signature", "type": "string", - "description": "For channel posts, optional author signature" + "description": "For channel posts and anonymous group messages, optional author signature" }, { "name": "media_album_id", "type": "int64", - "description": "Unique identifier of an album this message belongs to. Only photos and videos can be grouped together in albums" + "description": "Unique identifier of an album this message belongs to. Only audios, documents, photos and videos can be grouped together in albums" }, { "name": "restriction_reason", @@ -3261,7 +4260,7 @@ { "name": "total_count", "type": "int32", - "description": "Approximate total count of messages found" + "description": "Approximate total number of messages found" }, { "name": "messages", @@ -3281,7 +4280,7 @@ { "name": "total_count", "type": "int32", - "description": "Approximate total count of messages found; -1 if unknown" + "description": "Approximate total number of messages found; -1 if unknown" }, { "name": "messages", @@ -3300,10 +4299,220 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messagePosition", + "methods": [ + { + "name": "position", + "type": "int32", + "description": "0-based message position in the full list of suitable messages" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + }, + { + "name": "date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the message was sent" + } + ], + "description": "Contains information about a message in a specific position", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messagePositions", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Total number of messages found" + }, + { + "name": "positions", + "type": "vector", + "description": "List of message positions" + } + ], + "description": "Contains a list of message positions", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageCalendarDay", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Total number of found messages sent on the day" + }, + { + "name": "message", + "type": "message", + "description": "First message sent on the day" + } + ], + "description": "Contains information about found messages sent on a specific day", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageCalendar", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Total number of found messages" + }, + { + "name": "days", + "type": "vector", + "description": "Information about messages sent" + } + ], + "description": "Contains information about found messages, split by days according to the option \"utc_time_offset\"", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sponsoredMessage", + "methods": [ + { + "name": "message_id", + "type": "int53", + "description": "Message identifier; unique for the chat to which the sponsored message belongs among both ordinary and sponsored messages" + }, + { + "name": "is_recommended", + "type": "Bool", + "description": "True, if the message needs to be labeled as \"recommended\" instead of \"sponsored\"" + }, + { + "name": "sponsor_chat_id", + "type": "int53", + "description": "Sponsor chat identifier; 0 if the sponsor chat is accessible through an invite link" + }, + { + "name": "sponsor_chat_info", + "type": "chatInviteLinkInfo", + "description": "Information about the sponsor chat; may be null unless sponsor_chat_id == 0" + }, + { + "name": "link", + "type": "InternalLinkType", + "description": "An internal link to be opened when the sponsored message is clicked; may be null if the sponsor chat needs to be opened instead" + }, + { + "name": "content", + "type": "MessageContent", + "description": "Content of the message. Currently, can be only of the type messageText" + } + ], + "description": "Describes a sponsored message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "fileDownload", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "File identifier" + }, + { + "name": "message", + "type": "message", + "description": "The message with the file" + }, + { + "name": "add_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the file was added to the download list" + }, + { + "name": "complete_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the file downloading was completed; 0 if the file downloading isn't completed" + }, + { + "name": "is_paused", + "type": "Bool", + "description": "True, if downloading of the file is paused" + } + ], + "description": "Describes a file added to file download list", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "downloadedFileCounts", + "methods": [ + { + "name": "active_count", + "type": "int32", + "description": "Number of active file downloads found, including paused" + }, + { + "name": "paused_count", + "type": "int32", + "description": "Number of paused file downloads found" + }, + { + "name": "completed_count", + "type": "int32", + "description": "Number of completed file downloads found" + } + ], + "description": "Contains number of being downloaded and recently downloaded files found", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "foundFileDownloads", + "methods": [ + { + "name": "total_counts", + "type": "downloadedFileCounts", + "description": "Total number of suitable files, ignoring offset" + }, + { + "name": "files", + "type": "vector", + "description": "The list of files" + }, + { + "name": "next_offset", + "type": "string", + "description": "The offset for the next request. If empty, there are no more results" + } + ], + "description": "Contains a list of downloaded files, found by a search", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "NotificationSettingsScope", "methods": null, - "description": "Describes the types of chats to which notification settings are applied", + "description": "Describes the types of chats to which notification settings are relevant", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -3321,7 +4530,7 @@ { "name": "notificationSettingsScopeGroupChats", "methods": null, - "description": "Notification settings applied to all basic groups and supergroups when the corresponding chat setting has a default value", + "description": "Notification settings applied to all basic group and supergroup chats when the corresponding chat setting has a default value", "inheritance": "NotificationSettingsScope", "return_type": "", "isFunction": false, @@ -3330,7 +4539,7 @@ { "name": "notificationSettingsScopeChannelChats", "methods": null, - "description": "Notification settings applied to all channels when the corresponding chat setting has a default value", + "description": "Notification settings applied to all channel chats when the corresponding chat setting has a default value", "inheritance": "NotificationSettingsScope", "return_type": "", "isFunction": false, @@ -3352,12 +4561,12 @@ { "name": "use_default_sound", "type": "Bool", - "description": "If true, sound is ignored and the value for the relevant type of chat is used instead" + "description": "If true, the value for the relevant type of chat is used instead of sound_id" }, { - "name": "sound", - "type": "string", - "description": "The name of an audio file to be used for notification sounds; only applies to iOS applications" + "name": "sound_id", + "type": "int64", + "description": "Identifier of the notification sound to be played; 0 if sound is disabled" }, { "name": "use_default_show_preview", @@ -3367,7 +4576,7 @@ { "name": "show_preview", "type": "Bool", - "description": "True, if message content should be displayed in notifications" + "description": "True, if message content must be displayed in notifications" }, { "name": "use_default_disable_pinned_message_notifications", @@ -3405,14 +4614,14 @@ "description": "Time left before notifications will be unmuted, in seconds" }, { - "name": "sound", - "type": "string", - "description": "The name of an audio file to be used for notification sounds; only applies to iOS applications" + "name": "sound_id", + "type": "int64", + "description": "Identifier of the notification sound to be played; 0 if sound is disabled" }, { "name": "show_preview", "type": "Bool", - "description": "True, if message content should be displayed in notifications" + "description": "True, if message content must be displayed in notifications" }, { "name": "disable_pinned_message_notifications", @@ -3437,7 +4646,7 @@ { "name": "reply_to_message_id", "type": "int53", - "description": "Identifier of the message to reply to; 0 if none" + "description": "Identifier of the replied message; 0 if none" }, { "name": "date", @@ -3447,7 +4656,7 @@ { "name": "input_message_text", "type": "InputMessageContent", - "description": "Content of the message draft; this should always be of type inputMessageText" + "description": "Content of the message draft; must be of the type inputMessageText" } ], "description": "Contains information about a message draft", @@ -3470,7 +4679,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" } ], @@ -3485,11 +4694,11 @@ "methods": [ { "name": "basic_group_id", - "type": "int32", + "type": "int53", "description": "Basic group identifier" } ], - "description": "A basic group (i.e., a chat with 0-200 other users)", + "description": "A basic group (a chat with 0-200 other users)", "inheritance": "ChatType", "return_type": "", "isFunction": false, @@ -3500,7 +4709,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Supergroup or channel identifier" }, { @@ -3509,7 +4718,7 @@ "description": "True, if the supergroup is a channel" } ], - "description": "A supergroup (i.e. a chat with up to GetOption(\"supergroup_max_size\") other users), or channel (with unlimited members)", + "description": "A supergroup or channel (with unlimited members)", "inheritance": "ChatType", "return_type": "", "isFunction": false, @@ -3525,7 +4734,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier of the secret chat peer" } ], @@ -3546,27 +4755,27 @@ { "name": "icon_name", "type": "string", - "description": "The icon name for short filter representation. If non-empty, must be one of \"All\", \"Unread\", \"Unmuted\", \"Bots\", \"Channels\", \"Groups\", \"Private\", \"Custom\", \"Setup\", \"Cat\", \"Crown\", \"Favorite\", \"Flower\", \"Game\", \"Home\", \"Love\", \"Mask\", \"Party\", \"Sport\", \"Study\", \"Trade\", \"Travel\", \"Work\". If empty, use getChatFilterDefaultIconName to get default icon name for the filter" + "description": "The chosen icon name for short filter representation. If non-empty, must be one of \"All\", \"Unread\", \"Unmuted\", \"Bots\", \"Channels\", \"Groups\", \"Private\", \"Custom\", \"Setup\", \"Cat\", \"Crown\", \"Favorite\", \"Flower\", \"Game\", \"Home\", \"Love\", \"Mask\", \"Party\", \"Sport\", \"Study\", \"Trade\", \"Travel\", \"Work\", \"Airplane\", \"Book\", \"Light\", \"Like\", \"Money\", \"Note\", \"Palette\". If empty, use getChatFilterDefaultIconName to get default icon name for the filter" }, { "name": "pinned_chat_ids", "type": "vector", - "description": "The chat identifiers of pinned chats in the filtered chat list" + "description": "The chat identifiers of pinned chats in the filtered chat list. There can be up to GetOption(\"chat_filter_chosen_chat_count_max\") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium" }, { "name": "included_chat_ids", "type": "vector", - "description": "The chat identifiers of always included chats in the filtered chat list" + "description": "The chat identifiers of always included chats in the filtered chat list. There can be up to GetOption(\"chat_filter_chosen_chat_count_max\") pinned and always included non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium" }, { "name": "excluded_chat_ids", "type": "vector", - "description": "The chat identifiers of always excluded chats in the filtered chat list" + "description": "The chat identifiers of always excluded chats in the filtered chat list. There can be up to GetOption(\"chat_filter_chosen_chat_count_max\") always excluded non-secret chats and the same number of secret chats, but the limit can be increased with Telegram Premium" }, { "name": "exclude_muted", "type": "Bool", - "description": "True, if the muted chats need to be excluded" + "description": "True, if muted chats need to be excluded" }, { "name": "exclude_read", @@ -3626,7 +4835,7 @@ { "name": "icon_name", "type": "string", - "description": "The icon name for short filter representation. One of \"All\", \"Unread\", \"Unmuted\", \"Bots\", \"Channels\", \"Groups\", \"Private\", \"Custom\", \"Setup\", \"Cat\", \"Crown\", \"Favorite\", \"Flower\", \"Game\", \"Home\", \"Love\", \"Mask\", \"Party\", \"Sport\", \"Study\", \"Trade\", \"Travel\", \"Work\"" + "description": "The chosen or default icon name for short filter representation. One of \"All\", \"Unread\", \"Unmuted\", \"Bots\", \"Channels\", \"Groups\", \"Private\", \"Custom\", \"Setup\", \"Cat\", \"Crown\", \"Favorite\", \"Flower\", \"Game\", \"Home\", \"Love\", \"Mask\", \"Party\", \"Sport\", \"Study\", \"Trade\", \"Travel\", \"Work\", \"Airplane\", \"Book\", \"Light\", \"Like\", \"Money\", \"Note\", \"Palette\"" } ], "description": "Contains basic information about a chat filter", @@ -3795,6 +5004,64 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "ChatAvailableReactions", + "methods": null, + "description": "Describes reactions available in the chat", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatAvailableReactionsAll", + "methods": null, + "description": "All reactions are available in the chat", + "inheritance": "ChatAvailableReactions", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatAvailableReactionsSome", + "methods": [ + { + "name": "reactions", + "type": "vector", + "description": "The list of reactions" + } + ], + "description": "Only specific reactions are available in the chat", + "inheritance": "ChatAvailableReactions", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "videoChat", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier of an active video chat; 0 if none. Full information about the video chat can be received through the method getGroupCall" + }, + { + "name": "has_participants", + "type": "Bool", + "description": "True, if the video chat has participants" + }, + { + "name": "default_participant_id", + "type": "MessageSender", + "description": "Default group call participant identifier to join the video chat; may be null" + } + ], + "description": "Describes a video chat", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chat", "methods": [ @@ -3833,6 +5100,16 @@ "type": "vector", "description": "Positions of the chat in chat lists" }, + { + "name": "message_sender_id", + "type": "MessageSender", + "description": "Identifier of a user or chat that is selected to send messages in the chat; may be null if the user can't change message sender" + }, + { + "name": "has_protected_content", + "type": "Bool", + "description": "True, if chat content can't be saved locally, forwarded, or copied" + }, { "name": "is_marked_as_unread", "type": "Bool", @@ -3861,7 +5138,7 @@ { "name": "can_be_reported", "type": "Bool", - "description": "True, if the chat can be reported to Telegram moderators through reportChat" + "description": "True, if the chat can be reported to Telegram moderators through reportChat or reportChatPhoto" }, { "name": "default_disable_notification", @@ -3888,20 +5165,45 @@ "type": "int32", "description": "Number of unread messages with a mention/reply in the chat" }, + { + "name": "unread_reaction_count", + "type": "int32", + "description": "Number of messages with unread reactions in the chat" + }, { "name": "notification_settings", "type": "chatNotificationSettings", - "description": "Notification settings for this chat" + "description": "Notification settings for the chat" + }, + { + "name": "available_reactions", + "type": "ChatAvailableReactions", + "description": "Types of reaction, available in the chat" + }, + { + "name": "message_ttl", + "type": "int32", + "description": "Current message Time To Live setting (self-destruct timer) for the chat; 0 if not defined. TTL is counted from the time message or its content is viewed in secret chats and from the send date in other chats" + }, + { + "name": "theme_name", + "type": "string", + "description": "If non-empty, name of a theme, set for the chat" }, { "name": "action_bar", "type": "ChatActionBar", - "description": "Describes actions which should be possible to do through a chat action bar; may be null" + "description": "Information about actions which must be possible to do through the chat action bar; may be null" }, { - "name": "pinned_message_id", - "type": "int53", - "description": "Identifier of the pinned message in the chat; 0 if none" + "name": "video_chat", + "type": "videoChat", + "description": "Information about video chat of the chat" + }, + { + "name": "pending_join_requests", + "type": "chatJoinRequestsInfo", + "description": "Information about pending join requests; may be null" }, { "name": "reply_markup_message_id", @@ -3916,7 +5218,7 @@ { "name": "client_data", "type": "string", - "description": "Contains application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used" + "description": "Application-specific data associated with the chat. (For example, the chat scroll position or local chat notification settings can be stored here.) Persistent if the message database is used" } ], "description": "A chat. (Can be a private chat, basic group, supergroup, or secret chat)", @@ -3931,7 +5233,7 @@ { "name": "total_count", "type": "int32", - "description": "Approximate total count of chats found" + "description": "Approximate total number of chats found" }, { "name": "chat_ids", @@ -3956,7 +5258,7 @@ { "name": "distance", "type": "int32", - "description": "Distance to the chat location in meters" + "description": "Distance to the chat location, in meters" } ], "description": "Describes a chat located nearby", @@ -3985,71 +5287,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "chatInviteLink", - "methods": [ - { - "name": "invite_link", - "type": "string", - "description": "Chat invite link" - } - ], - "description": "Contains a chat invite link", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatInviteLinkInfo", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier of the invite link; 0 if the user has no access to the chat before joining" - }, - { - "name": "accessible_for", - "type": "int32", - "description": "If non-zero, the remaining time for which read access is granted to the chat, in seconds" - }, - { - "name": "type", - "type": "ChatType", - "description": "Contains information about the type of the chat" - }, - { - "name": "title", - "type": "string", - "description": "Title of the chat" - }, - { - "name": "photo", - "type": "chatPhotoInfo", - "description": "Chat photo; may be null" - }, - { - "name": "member_count", - "type": "int32", - "description": "Number of members in the chat" - }, - { - "name": "member_user_ids", - "type": "vector", - "description": "User identifiers of some chat members that may be known to the current user" - }, - { - "name": "is_public", - "type": "Bool", - "description": "True, if the chat is a public supergroup or channel, i.e. it has a username or it is a location-based supergroup" - } - ], - "description": "Contains information about a chat invite link", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "PublicChatType", "methods": null, @@ -4080,7 +5317,7 @@ { "name": "ChatActionBar", "methods": null, - "description": "Describes actions which should be possible to do through a chat action bar", + "description": "Describes actions which must be possible to do through a chat action bar", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -4110,6 +5347,15 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatActionBarInviteMembers", + "methods": null, + "description": "The chat is a recently created group chat to which new members can be invited", + "inheritance": "ChatActionBar", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatActionBarReportAddBlock", "methods": [ @@ -4124,7 +5370,7 @@ "description": "If non-negative, the current user was found by the peer through searchChatsNearby and this is the distance between the users" } ], - "description": "The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blocked using the method blockUser, or the other user can be added to the contact list using the method addContact", + "description": "The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be blocked using the method toggleMessageSenderIsBlocked, or the other user can be added to the contact list using the method addContact", "inheritance": "ChatActionBar", "return_type": "", "isFunction": false, @@ -4148,6 +5394,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatActionBarJoinRequest", + "methods": [ + { + "name": "title", + "type": "string", + "description": "Title of the chat to which the join request was sent" + }, + { + "name": "is_channel", + "type": "Bool", + "description": "True, if the join request was sent to a channel chat" + }, + { + "name": "request_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the join request was sent" + } + ], + "description": "The chat is a private chat with an administrator of a chat to which the user sent join request", + "inheritance": "ChatActionBar", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "KeyboardButtonType", "methods": null, @@ -4160,7 +5431,7 @@ { "name": "keyboardButtonTypeText", "methods": null, - "description": "A simple button, with text that should be sent when the button is pressed", + "description": "A simple button, with text that must be sent when the button is pressed", "inheritance": "KeyboardButtonType", "return_type": "", "isFunction": false, @@ -4204,6 +5475,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "keyboardButtonTypeWebApp", + "methods": [ + { + "name": "url", + "type": "string", + "description": "An HTTP URL to pass to getWebAppUrl" + } + ], + "description": "A button that opens a Web App by calling getWebAppUrl", + "inheritance": "KeyboardButtonType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "keyboardButton", "methods": [ @@ -4254,11 +5540,11 @@ { "name": "url", "type": "string", - "description": "An HTTP URL to open" + "description": "An HTTP URL to pass to getLoginUrlInfo" }, { "name": "id", - "type": "int32", + "type": "int53", "description": "Unique button identifier" }, { @@ -4267,7 +5553,22 @@ "description": "If non-empty, new text of the button in forwarded messages" } ], - "description": "A button that opens a specified URL and automatically logs in in current user if they allowed to do that", + "description": "A button that opens a specified URL and automatically authorize the current user by calling getLoginUrlInfo", + "inheritance": "InlineKeyboardButtonType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "inlineKeyboardButtonTypeWebApp", + "methods": [ + { + "name": "url", + "type": "string", + "description": "An HTTP URL to pass to openWebApp" + } + ], + "description": "A button that opens a Web App by calling openWebApp", "inheritance": "InlineKeyboardButtonType", "return_type": "", "isFunction": false, @@ -4297,7 +5598,7 @@ "description": "Data to be sent to the bot via a callback query" } ], - "description": "A button that asks for password of the current user and then sends a callback query to a bot", + "description": "A button that asks for the 2-step verification password of the current user and then sends a callback query to a bot", "inheritance": "InlineKeyboardButtonType", "return_type": "", "isFunction": false, @@ -4323,7 +5624,7 @@ { "name": "in_current_chat", "type": "Bool", - "description": "True, if the inline query should be sent from the current chat" + "description": "True, if the inline query must be sent from the current chat" } ], "description": "A button that forces an inline query to the bot to be inserted in the input field", @@ -4341,6 +5642,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "inlineKeyboardButtonTypeUser", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "User identifier" + } + ], + "description": "A button with a user reference to be handled in the same way as textEntityTypeMentionName entities", + "inheritance": "InlineKeyboardButtonType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "inlineKeyboardButton", "methods": [ @@ -4392,6 +5708,11 @@ "name": "is_personal", "type": "Bool", "description": "True, if a forced reply must automatically be shown to the current user. For outgoing messages, specify true to show the forced reply only for the mentioned users and for the target user of a reply" + }, + { + "name": "input_field_placeholder", + "type": "string", + "description": "If non-empty, the placeholder to be shown in the input field when the reply is active; 0-64 characters" } ], "description": "Instructs application to force a reply to this message", @@ -4422,6 +5743,11 @@ "name": "is_personal", "type": "Bool", "description": "True, if the keyboard must automatically be shown to the current user. For outgoing messages, specify true to show the keyboard only for the mentioned users and for the target user of a reply" + }, + { + "name": "input_field_placeholder", + "type": "string", + "description": "If non-empty, the placeholder to be shown in the input field when the keyboard is active; 0-64 characters" } ], "description": "Contains a custom keyboard layout to quickly reply to bots", @@ -4489,7 +5815,7 @@ }, { "name": "bot_user_id", - "type": "int32", + "type": "int53", "description": "User identifier of a bot linked with the website" }, { @@ -4504,6 +5830,26 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "webAppInfo", + "methods": [ + { + "name": "launch_id", + "type": "int64", + "description": "Unique identifier for the Web App launch" + }, + { + "name": "url", + "type": "string", + "description": "A Web App URL to open in a web view" + } + ], + "description": "Contains information about a Web App", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageThreadInfo", "methods": [ @@ -4517,6 +5863,16 @@ "type": "int53", "description": "Message thread identifier, unique within the chat" }, + { + "name": "reply_info", + "type": "messageReplyInfo", + "description": "Information about the message thread" + }, + { + "name": "unread_message_count", + "type": "int32", + "description": "Approximate number of unread messages in the message thread" + }, { "name": "messages", "type": "vector", @@ -4754,12 +6110,12 @@ { "name": "width", "type": "int32", - "description": "Width of a bounding box in which the image should be shown; 0 if unknown" + "description": "Width of a bounding box in which the image must be shown; 0 if unknown" }, { "name": "height", "type": "int32", - "description": "Height of a bounding box in which the image should be shown; 0 if unknown" + "description": "Height of a bounding box in which the image must be shown; 0 if unknown" } ], "description": "A small image inside the text", @@ -4777,9 +6133,9 @@ "description": "The text" }, { - "name": "reference_text", - "type": "RichText", - "description": "The text to show on click" + "name": "anchor_name", + "type": "string", + "description": "The name of a richTextAnchor object, which is the first element of the target richTexts object" }, { "name": "url", @@ -4787,7 +6143,7 @@ "description": "An HTTP URL, opening the reference" } ], - "description": "A rich text reference of a text on the same web page", + "description": "A reference to a richTexts object on the same web page", "inheritance": "RichText", "return_type": "", "isFunction": false, @@ -4817,9 +6173,9 @@ "description": "The link text" }, { - "name": "name", + "name": "anchor_name", "type": "string", - "description": "The anchor name. If the name is empty, the link should bring back to top" + "description": "The anchor name. If the name is empty, the link must bring back to top" }, { "name": "url", @@ -4900,7 +6256,7 @@ { "name": "pageBlockHorizontalAlignmentLeft", "methods": null, - "description": "The content should be left-aligned", + "description": "The content must be left-aligned", "inheritance": "PageBlockHorizontalAlignment", "return_type": "", "isFunction": false, @@ -4909,7 +6265,7 @@ { "name": "pageBlockHorizontalAlignmentCenter", "methods": null, - "description": "The content should be center-aligned", + "description": "The content must be center-aligned", "inheritance": "PageBlockHorizontalAlignment", "return_type": "", "isFunction": false, @@ -4918,7 +6274,7 @@ { "name": "pageBlockHorizontalAlignmentRight", "methods": null, - "description": "The content should be right-aligned", + "description": "The content must be right-aligned", "inheritance": "PageBlockHorizontalAlignment", "return_type": "", "isFunction": false, @@ -4936,7 +6292,7 @@ { "name": "pageBlockVerticalAlignmentTop", "methods": null, - "description": "The content should be top-aligned", + "description": "The content must be top-aligned", "inheritance": "PageBlockVerticalAlignment", "return_type": "", "isFunction": false, @@ -4945,7 +6301,7 @@ { "name": "pageBlockVerticalAlignmentMiddle", "methods": null, - "description": "The content should be middle-aligned", + "description": "The content must be middle-aligned", "inheritance": "PageBlockVerticalAlignment", "return_type": "", "isFunction": false, @@ -4954,7 +6310,7 @@ { "name": "pageBlockVerticalAlignmentBottom", "methods": null, - "description": "The content should be bottom-aligned", + "description": "The content must be bottom-aligned", "inheritance": "PageBlockVerticalAlignment", "return_type": "", "isFunction": false, @@ -4966,7 +6322,7 @@ { "name": "text", "type": "RichText", - "description": "Cell text; may be null. If the text is null, then the cell should be invisible" + "description": "Cell text; may be null. If the text is null, then the cell must be invisible" }, { "name": "is_header", @@ -4976,12 +6332,12 @@ { "name": "colspan", "type": "int32", - "description": "The number of columns the cell should span" + "description": "The number of columns the cell spans" }, { "name": "rowspan", "type": "int32", - "description": "The number of rows the cell should span" + "description": "The number of rows the cell spans" }, { "name": "align", @@ -5170,7 +6526,7 @@ { "name": "language", "type": "string", - "description": "Programming language for which the text should be formatted" + "description": "Programming language for which the text needs to be formatted" } ], "description": "A preformatted text paragraph", @@ -5289,7 +6645,7 @@ { "name": "need_autoplay", "type": "Bool", - "description": "True, if the animation should be played automatically" + "description": "True, if the animation must be played automatically" } ], "description": "An animation", @@ -5359,12 +6715,12 @@ { "name": "need_autoplay", "type": "Bool", - "description": "True, if the video should be played automatically" + "description": "True, if the video must be played automatically" }, { "name": "is_looped", "type": "Bool", - "description": "True, if the video should be looped" + "description": "True, if the video must be looped" } ], "description": "A video", @@ -5444,12 +6800,12 @@ { "name": "is_full_width", "type": "Bool", - "description": "True, if the block should be full width" + "description": "True, if the block must be full width" }, { "name": "allow_scrolling", "type": "Bool", - "description": "True, if scrolling should be allowed" + "description": "True, if scrolling needs to be allowed" } ], "description": "An embedded web page", @@ -5554,7 +6910,7 @@ { "name": "username", "type": "string", - "description": "Chat username, by which all other information about the chat should be resolved" + "description": "Chat username by which all other information about the chat can be resolved" } ], "description": "A link to a chat", @@ -5689,7 +7045,7 @@ { "name": "version", "type": "int32", - "description": "Version of the instant view, currently can be 1 or 2" + "description": "Version of the instant view; currently, can be 1 or 2" }, { "name": "is_rtl", @@ -5700,6 +7056,11 @@ "name": "is_full", "type": "Bool", "description": "True, if the instant view contains the full page. A network request might be needed to get the full web page instant view" + }, + { + "name": "feedback_link", + "type": "InternalLinkType", + "description": "An internal link to be opened to leave feedback about the instant view" } ], "description": "Describes an instant view page for a web page", @@ -5789,7 +7150,7 @@ { "name": "document", "type": "document", - "description": "Preview of the content as a document, if available (currently only available for small PDF files and ZIP archives); may be null" + "description": "Preview of the content as a document, if available; may be null" }, { "name": "sticker", @@ -5814,7 +7175,7 @@ { "name": "instant_view_version", "type": "int32", - "description": "Version of instant view, available for the web page (currently can be 1 or 2), 0 if none" + "description": "Version of instant view, available for the web page (currently, can be 1 or 2), 0 if none" } ], "description": "Describes a web page preview", @@ -5844,7 +7205,7 @@ { "name": "is_hidden", "type": "Bool", - "description": "True, if the country should be hidden from the list of all countries" + "description": "True, if the country must be hidden from the list of all countries" }, { "name": "calling_codes", @@ -5889,7 +7250,7 @@ { "name": "formatted_phone_number", "type": "string", - "description": "The phone number without country calling code formatted accordingly to local rules" + "description": "The phone number without country calling code formatted accordingly to local rules. Expected digits are returned as '-', but even more digits might be entered by the user" } ], "description": "Contains information about a phone number", @@ -5978,6 +7339,51 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "themeParameters", + "methods": [ + { + "name": "background_color", + "type": "int32", + "description": "A color of the background in the RGB24 format" + }, + { + "name": "secondary_background_color", + "type": "int32", + "description": "A secondary color for the background in the RGB24 format" + }, + { + "name": "text_color", + "type": "int32", + "description": "A color of text in the RGB24 format" + }, + { + "name": "hint_color", + "type": "int32", + "description": "A color of hints in the RGB24 format" + }, + { + "name": "link_color", + "type": "int32", + "description": "A color of links in the RGB24 format" + }, + { + "name": "button_color", + "type": "int32", + "description": "A color of the buttons in the RGB24 format" + }, + { + "name": "button_text_color", + "type": "int32", + "description": "A color of text on the buttons in the RGB24 format" + } + ], + "description": "Contains parameters of the application theme", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "labeledPricePart", "methods": [ @@ -5989,7 +7395,7 @@ { "name": "amount", "type": "int53", - "description": "Currency amount in minimal quantity of the currency" + "description": "Currency amount in the smallest units of the currency" } ], "description": "Portion of the price of a product (e.g., \"delivery cost\", \"tax amount\")", @@ -6011,6 +7417,21 @@ "type": "vector", "description": "A list of objects used to calculate the total price of the product" }, + { + "name": "max_tip_amount", + "type": "int53", + "description": "The maximum allowed amount of tip in the smallest units of the currency" + }, + { + "name": "suggested_tip_amounts", + "type": "vector", + "description": "Suggested amounts of tip in the smallest units of the currency" + }, + { + "name": "recurring_payment_terms_of_service_url", + "type": "string", + "description": "An HTTP URL with terms of service for recurring payments. If non-empty, the invoice payment will result in recurring payments and the user must accept the terms of service before allowed to pay" + }, { "name": "is_test", "type": "Bool", @@ -6127,7 +7548,7 @@ "description": "Title of the saved credentials" } ], - "description": "Contains information about saved card credentials", + "description": "Contains information about saved payment credentials", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -6163,7 +7584,7 @@ { "name": "data", "type": "string", - "description": "Contains JSON-encoded data with a credential identifier from the payment provider" + "description": "JSON-encoded data with the credential identifier from the payment provider" }, { "name": "allow_save", @@ -6177,21 +7598,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "inputCredentialsAndroidPay", - "methods": [ - { - "name": "data", - "type": "string", - "description": "JSON-encoded data with the credential identifier" - } - ], - "description": "Applies if a user enters new credentials using Android Pay", - "inheritance": "InputCredentials", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "inputCredentialsApplePay", "methods": [ @@ -6208,7 +7614,46 @@ "isSynchronous": false }, { - "name": "paymentsProviderStripe", + "name": "inputCredentialsGooglePay", + "methods": [ + { + "name": "data", + "type": "string", + "description": "JSON-encoded data with the credential identifier" + } + ], + "description": "Applies if a user enters new credentials using Google Pay", + "inheritance": "InputCredentials", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "PaymentProvider", + "methods": null, + "description": "Contains information about a payment provider", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "paymentProviderSmartGlocal", + "methods": [ + { + "name": "public_token", + "type": "string", + "description": "Public payment token" + } + ], + "description": "Smart Glocal payment provider", + "inheritance": "PaymentProvider", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "paymentProviderStripe", "methods": [ { "name": "publishable_key", @@ -6232,6 +7677,41 @@ } ], "description": "Stripe payment provider", + "inheritance": "PaymentProvider", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "paymentProviderOther", + "methods": [ + { + "name": "url", + "type": "string", + "description": "Payment form URL" + } + ], + "description": "Some other payment provider, for which a web payment form must be shown", + "inheritance": "PaymentProvider", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "paymentOption", + "methods": [ + { + "name": "title", + "type": "string", + "description": "Title for the payment option" + }, + { + "name": "url", + "type": "string", + "description": "Payment form URL to be opened in a web view" + } + ], + "description": "Describes an additional payment option", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -6240,20 +7720,35 @@ { "name": "paymentForm", "methods": [ + { + "name": "id", + "type": "int64", + "description": "The payment form identifier" + }, { "name": "invoice", "type": "invoice", - "description": "Full information of the invoice" + "description": "Full information about the invoice" }, { - "name": "url", - "type": "string", - "description": "Payment form URL" + "name": "seller_bot_user_id", + "type": "int53", + "description": "User identifier of the seller bot" }, { - "name": "payments_provider", - "type": "paymentsProviderStripe", - "description": "Contains information about the payment provider, if available, to support it natively without the need for opening the URL; may be null" + "name": "payment_provider_user_id", + "type": "int53", + "description": "User identifier of the payment provider bot" + }, + { + "name": "payment_provider", + "type": "PaymentProvider", + "description": "Information about the payment provider" + }, + { + "name": "additional_payment_options", + "type": "vector", + "description": "The list of additional payment options" }, { "name": "saved_order_info", @@ -6262,8 +7757,8 @@ }, { "name": "saved_credentials", - "type": "savedCredentials", - "description": "Contains information about saved card credentials; may be null" + "type": "vector", + "description": "The list of saved payment credentials" }, { "name": "can_save_credentials", @@ -6273,7 +7768,22 @@ { "name": "need_password", "type": "Bool", - "description": "True, if the user will be able to save credentials protected by a password they set up" + "description": "True, if the user will be able to save credentials, if sets up a 2-step verification password" + }, + { + "name": "product_title", + "type": "string", + "description": "Product title" + }, + { + "name": "product_description", + "type": "formattedText", + "description": "Product description" + }, + { + "name": "product_photo", + "type": "photo", + "description": "Product photo; may be null" } ], "description": "Contains information about an invoice payment form", @@ -6308,7 +7818,7 @@ { "name": "success", "type": "Bool", - "description": "True, if the payment request was successful; otherwise the verification_url will be not empty" + "description": "True, if the payment request was successful; otherwise the verification_url will be non-empty" }, { "name": "verification_url", @@ -6325,25 +7835,45 @@ { "name": "paymentReceipt", "methods": [ + { + "name": "title", + "type": "string", + "description": "Product title" + }, + { + "name": "description", + "type": "formattedText", + "description": "Product description" + }, + { + "name": "photo", + "type": "photo", + "description": "Product photo; may be null" + }, { "name": "date", "type": "int32", "description": "Point in time (Unix timestamp) when the payment was made" }, { - "name": "payments_provider_user_id", - "type": "int32", + "name": "seller_bot_user_id", + "type": "int53", + "description": "User identifier of the seller bot" + }, + { + "name": "payment_provider_user_id", + "type": "int53", "description": "User identifier of the payment provider bot" }, { "name": "invoice", "type": "invoice", - "description": "Contains information about the invoice" + "description": "Information about the invoice" }, { "name": "order_info", "type": "orderInfo", - "description": "Contains order information; may be null" + "description": "Order information; may be null" }, { "name": "shipping_option", @@ -6353,7 +7883,12 @@ { "name": "credentials_title", "type": "string", - "description": "Title of the saved credentials" + "description": "Title of the saved credentials chosen by the buyer" + }, + { + "name": "tip_amount", + "type": "int53", + "description": "The amount of tip chosen by the buyer in the smallest units of the currency" } ], "description": "Contains information about a successful payment", @@ -6362,6 +7897,50 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "InputInvoice", + "methods": null, + "description": "Describe an invoice to process", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "inputInvoiceMessage", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier of the message" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + } + ], + "description": "An invoice from a message of the type messageInvoice", + "inheritance": "InputInvoice", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "inputInvoiceName", + "methods": [ + { + "name": "name", + "type": "string", + "description": "Name of the invoice" + } + ], + "description": "An invoice from a link of the type internalLinkTypeInvoice", + "inheritance": "InputInvoice", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "datedFile", "methods": [ @@ -6514,17 +8093,17 @@ { "name": "day", "type": "int32", - "description": "Day of the month, 1-31" + "description": "Day of the month; 1-31" }, { "name": "month", "type": "int32", - "description": "Month, 1-12" + "description": "Month; 1-12" }, { "name": "year", "type": "int32", - "description": "Year, 1-9999" + "description": "Year; 1-9999" } ], "description": "Represents a date according to the Gregorian calendar", @@ -6604,7 +8183,7 @@ { "name": "expiry_date", "type": "date", - "description": "Document expiry date; may be null" + "description": "Document expiry date; may be null if not applicable" }, { "name": "front_side", @@ -6614,7 +8193,7 @@ { "name": "reverse_side", "type": "datedFile", - "description": "Reverse side of the document; only for driver license and identity card" + "description": "Reverse side of the document; only for driver license and identity card; may be null" }, { "name": "selfie", @@ -6644,7 +8223,7 @@ { "name": "expiry_date", "type": "date", - "description": "Document expiry date, if available" + "description": "Document expiry date; pass null if not applicable" }, { "name": "front_side", @@ -6654,12 +8233,12 @@ { "name": "reverse_side", "type": "InputFile", - "description": "Reverse side of the document; only for driver license and identity card" + "description": "Reverse side of the document; only for driver license and identity card; pass null otherwise" }, { "name": "selfie", "type": "InputFile", - "description": "Selfie with the document, if available" + "description": "Selfie with the document; pass null if unavailable" }, { "name": "translation", @@ -7325,7 +8904,7 @@ { "name": "required_elements", "type": "vector", - "description": "Information about the Telegram Passport elements that need to be provided to complete the form" + "description": "Telegram Passport elements that must be provided to complete the form" }, { "name": "privacy_policy_url", @@ -7748,6 +9327,11 @@ "name": "sticker", "type": "sticker", "description": "The sticker description" + }, + { + "name": "is_premium", + "type": "Bool", + "description": "True, if premium animation of the sticker must be played" } ], "description": "A sticker message", @@ -7851,12 +9435,22 @@ { "name": "live_period", "type": "int32", - "description": "Time relative to the message sent date until which the location can be updated, in seconds" + "description": "Time relative to the message send date, for which the location can be updated, in seconds" }, { "name": "expires_in", "type": "int32", "description": "Left time for which the location can be updated, in seconds. updateMessageContent is not sent when this field changes" + }, + { + "name": "heading", + "type": "int32", + "description": "For live locations, a direction in which the location moves, in degrees; 1-360. If 0 the direction is unknown" + }, + { + "name": "proximity_alert_radius", + "type": "int32", + "description": "For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). 0 if the notification is disabled. Available only for the message sender" } ], "description": "A message with a location", @@ -7895,18 +9489,38 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageAnimatedEmoji", + "methods": [ + { + "name": "animated_emoji", + "type": "animatedEmoji", + "description": "The animated emoji" + }, + { + "name": "emoji", + "type": "string", + "description": "The corresponding emoji" + } + ], + "description": "A message with an animated emoji", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageDice", "methods": [ { - "name": "initial_state_sticker", - "type": "sticker", - "description": "The animated sticker with the initial dice animation; may be null if unknown. updateMessageContent will be sent when the sticker became known" + "name": "initial_state", + "type": "DiceStickers", + "description": "The animated stickers with the initial dice animation; may be null if unknown. updateMessageContent will be sent when the sticker became known" }, { - "name": "final_state_sticker", - "type": "sticker", - "description": "The animated sticker with the final dice animation; may be null if unknown. updateMessageContent will be sent when the sticker became known" + "name": "final_state", + "type": "DiceStickers", + "description": "The animated stickers with the final dice animation; may be null if unknown. updateMessageContent will be sent when the sticker became known" }, { "name": "emoji", @@ -7970,7 +9584,7 @@ }, { "name": "description", - "type": "string", + "type": "formattedText", "description": "Product description" }, { @@ -7986,7 +9600,7 @@ { "name": "total_amount", "type": "int53", - "description": "Product total price in the minimal quantity of the currency" + "description": "Product total price in the smallest units of the currency" }, { "name": "start_parameter", @@ -8001,7 +9615,7 @@ { "name": "need_shipping_address", "type": "Bool", - "description": "True, if the shipping address should be specified" + "description": "True, if the shipping address must be specified" }, { "name": "receipt_message_id", @@ -8040,6 +9654,76 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageVideoChatScheduled", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall" + }, + { + "name": "start_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the group call is supposed to be started by an administrator" + } + ], + "description": "A new video chat was scheduled", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageVideoChatStarted", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall" + } + ], + "description": "A newly created video chat", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageVideoChatEnded", + "methods": [ + { + "name": "duration", + "type": "int32", + "description": "Call duration, in seconds" + } + ], + "description": "A message with information about an ended video chat", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageInviteVideoChatParticipants", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall" + }, + { + "name": "user_ids", + "type": "vector", + "description": "Invited user identifiers" + } + ], + "description": "A message with information about an invite to a video chat", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageBasicGroupChatCreate", "methods": [ @@ -8050,7 +9734,7 @@ }, { "name": "member_user_ids", - "type": "vector", + "type": "vector", "description": "User identifiers of members in the basic group" } ], @@ -8119,7 +9803,7 @@ "methods": [ { "name": "member_user_ids", - "type": "vector", + "type": "vector", "description": "User identifiers of the new members" } ], @@ -8132,7 +9816,16 @@ { "name": "messageChatJoinByLink", "methods": null, - "description": "A new member joined the chat by invite link", + "description": "A new member joined the chat via an invite link", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageChatJoinByRequest", + "methods": null, + "description": "A new member was accepted to the chat by an administrator", "inheritance": "MessageContent", "return_type": "", "isFunction": false, @@ -8143,7 +9836,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier of the deleted chat member" } ], @@ -8158,7 +9851,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the supergroup to which the basic group was upgraded" } ], @@ -8178,7 +9871,7 @@ }, { "name": "basic_group_id", - "type": "int32", + "type": "int53", "description": "The identifier of the original basic group" } ], @@ -8212,16 +9905,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageChatSetTheme", + "methods": [ + { + "name": "theme_name", + "type": "string", + "description": "If non-empty, name of a new theme, set for the chat. Otherwise chat theme was reset to the default one" + } + ], + "description": "A theme in the chat has been changed", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageChatSetTtl", "methods": [ { "name": "ttl", "type": "int32", - "description": "New TTL" + "description": "New message TTL" } ], - "description": "The TTL (Time To Live) setting messages in a secret chat has been changed", + "description": "The TTL (Time To Live) setting for messages in the chat has been changed", "inheritance": "MessageContent", "return_type": "", "isFunction": false, @@ -8270,10 +9978,15 @@ { "name": "messagePaymentSuccessful", "methods": [ + { + "name": "invoice_chat_id", + "type": "int53", + "description": "Identifier of the chat, containing the corresponding invoice message; 0 if unknown" + }, { "name": "invoice_message_id", "type": "int53", - "description": "Identifier of the message with the corresponding invoice; can be an identifier of a deleted message" + "description": "Identifier of the message with the corresponding invoice; can be 0 or an identifier of a deleted message" }, { "name": "currency", @@ -8283,7 +9996,22 @@ { "name": "total_amount", "type": "int53", - "description": "Total price for the product, in the minimal quantity of the currency" + "description": "Total price for the product, in the smallest units of the currency" + }, + { + "name": "is_recurring", + "type": "Bool", + "description": "True, if this is a recurring payment" + }, + { + "name": "is_first_recurring", + "type": "Bool", + "description": "True, if this is the first recurring payment" + }, + { + "name": "invoice_name", + "type": "string", + "description": "Name of the invoice; may be empty if unknown" } ], "description": "A payment has been completed", @@ -8295,11 +10023,6 @@ { "name": "messagePaymentSuccessfulBot", "methods": [ - { - "name": "invoice_message_id", - "type": "int53", - "description": "Identifier of the message with the corresponding invoice; can be an identifier of a deleted message" - }, { "name": "currency", "type": "string", @@ -8308,7 +10031,17 @@ { "name": "total_amount", "type": "int53", - "description": "Total price for the product, in the minimal quantity of the currency" + "description": "Total price for the product, in the smallest units of the currency" + }, + { + "name": "is_recurring", + "type": "Bool", + "description": "True, if this is a recurring payment" + }, + { + "name": "is_first_recurring", + "type": "Bool", + "description": "True, if this is the first recurring payment" }, { "name": "invoice_payload", @@ -8342,6 +10075,36 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageGiftedPremium", + "methods": [ + { + "name": "currency", + "type": "string", + "description": "Currency for the paid amount" + }, + { + "name": "amount", + "type": "int53", + "description": "The paid amount, in the smallest units of the currency" + }, + { + "name": "month_count", + "type": "int32", + "description": "Number of month the Telegram Premium subscription will be active" + }, + { + "name": "sticker", + "type": "sticker", + "description": "A sticker to be shown in the message; may be null if unknown" + } + ], + "description": "Telegram Premium was gifted to the user", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageContactRegistered", "methods": null, @@ -8366,6 +10129,41 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageWebAppDataSent", + "methods": [ + { + "name": "button_text", + "type": "string", + "description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App" + } + ], + "description": "Data from a Web App has been sent to a bot", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageWebAppDataReceived", + "methods": [ + { + "name": "button_text", + "type": "string", + "description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App" + }, + { + "name": "data", + "type": "string", + "description": "Received data" + } + ], + "description": "Data from a Web App has been received; for bots only", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messagePassportDataSent", "methods": [ @@ -8375,7 +10173,7 @@ "description": "List of Telegram Passport element types sent" } ], - "description": "Telegram Passport data has been sent", + "description": "Telegram Passport data has been sent to a bot", "inheritance": "MessageContent", "return_type": "", "isFunction": false, @@ -8401,6 +10199,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "messageProximityAlertTriggered", + "methods": [ + { + "name": "traveler_id", + "type": "MessageSender", + "description": "The identifier of a user or chat that triggered the proximity alert" + }, + { + "name": "watcher_id", + "type": "MessageSender", + "description": "The identifier of a user or chat that subscribed for the proximity alert" + }, + { + "name": "distance", + "type": "int32", + "description": "The distance between the users" + } + ], + "description": "A user in the chat came within proximity alert range", + "inheritance": "MessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "messageUnsupported", "methods": null, @@ -8440,7 +10263,7 @@ { "name": "textEntityTypeCashtag", "methods": null, - "description": "A cashtag text, beginning with \"$\" and consisting of capital english letters (i.e. \"$USD\")", + "description": "A cashtag text, beginning with \"$\" and consisting of capital English letters (e.g., \"$USD\")", "inheritance": "TextEntityType", "return_type": "", "isFunction": false, @@ -8449,7 +10272,7 @@ { "name": "textEntityTypeBotCommand", "methods": null, - "description": "A bot command, beginning with \"/\". This shouldn't be highlighted if there are no bots in the chat", + "description": "A bot command, beginning with \"/\"", "inheritance": "TextEntityType", "return_type": "", "isFunction": false, @@ -8527,6 +10350,15 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "textEntityTypeSpoiler", + "methods": null, + "description": "A spoiler text", + "inheritance": "TextEntityType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "textEntityTypeCode", "methods": null, @@ -8580,7 +10412,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the mentioned user" } ], @@ -8590,6 +10422,36 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "textEntityTypeCustomEmoji", + "methods": [ + { + "name": "custom_emoji_id", + "type": "int64", + "description": "Unique identifier of the custom emoji" + } + ], + "description": "A custom emoji. The text behind a custom emoji must be an emoji. Only premium users can use premium custom emoji", + "inheritance": "TextEntityType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "textEntityTypeMediaTimestamp", + "methods": [ + { + "name": "media_timestamp", + "type": "int32", + "description": "Timestamp from which a video/audio/video note/voice note playing must start, in seconds. The media can be in the content or the web page preview of the current message, or in the same places in the replied message" + } + ], + "description": "A media timestamp", + "inheritance": "TextEntityType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "inputThumbnail", "methods": [ @@ -8661,10 +10523,20 @@ "type": "Bool", "description": "Pass true if the message is sent from the background" }, + { + "name": "protect_content", + "type": "Bool", + "description": "Pass true if the content of the message must be protected from forwarding and saving; for bots only" + }, + { + "name": "update_order_of_installed_sticker_sets", + "type": "Bool", + "description": "Pass true if the user explicitly chosen a sticker or a custom emoji from an installed sticker set; applicable only to sendMessage and sendMessageAlbum" + }, { "name": "scheduling_state", "type": "MessageSchedulingState", - "description": "Message scheduling state. Messages sent to a secret chat, live location messages and self-destructing messages can't be scheduled" + "description": "Message scheduling state; pass null to send message immediately. Messages sent to a secret chat, live location messages and self-destructing messages can't be scheduled" } ], "description": "Options to be used when a message is sent", @@ -8679,7 +10551,7 @@ { "name": "send_copy", "type": "Bool", - "description": "True, if content of the message needs to be copied without a link to the original message. Always true if the message is forwarded to a secret chat" + "description": "True, if content of the message needs to be copied without reference to the original sender. Always true if the message is forwarded to a secret chat or is local" }, { "name": "replace_caption", @@ -8689,10 +10561,10 @@ { "name": "new_caption", "type": "formattedText", - "description": "New message caption. Ignored if replace_caption is false" + "description": "New message caption; pass null to copy message without caption. Ignored if replace_caption is false" } ], - "description": "Options to be used when a message content is copied without a link to the original message", + "description": "Options to be used when a message content is copied without reference to the original sender. Service messages and messageInvoice can't be copied", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -8713,17 +10585,17 @@ { "name": "text", "type": "formattedText", - "description": "Formatted text to be sent; 1-GetOption(\"message_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Code, Pre, PreCode, TextUrl and MentionName entities are allowed to be specified manually" + "description": "Formatted text to be sent; 1-GetOption(\"message_text_length_max\") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, Code, Pre, PreCode, TextUrl and MentionName entities are allowed to be specified manually" }, { "name": "disable_web_page_preview", "type": "Bool", - "description": "True, if rich web page previews for URLs in the message text should be disabled" + "description": "True, if rich web page previews for URLs in the message text must be disabled" }, { "name": "clear_draft", "type": "Bool", - "description": "True, if a chat message draft should be deleted" + "description": "True, if a chat message draft must be deleted" } ], "description": "A text message", @@ -8743,7 +10615,7 @@ { "name": "thumbnail", "type": "inputThumbnail", - "description": "Animation thumbnail, if available" + "description": "Animation thumbnail; pass null to skip thumbnail uploading" }, { "name": "added_sticker_file_ids", @@ -8768,7 +10640,7 @@ { "name": "caption", "type": "formattedText", - "description": "Animation caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "Animation caption; pass null to use an empty caption; 0-GetOption(\"message_caption_length_max\") characters" } ], "description": "An animation message (GIF-style).", @@ -8788,7 +10660,7 @@ { "name": "album_cover_thumbnail", "type": "inputThumbnail", - "description": "Thumbnail of the cover for the album, if available" + "description": "Thumbnail of the cover for the album; pass null to skip thumbnail uploading" }, { "name": "duration", @@ -8808,7 +10680,7 @@ { "name": "caption", "type": "formattedText", - "description": "Audio caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "Audio caption; pass null to use an empty caption; 0-GetOption(\"message_caption_length_max\") characters" } ], "description": "An audio message", @@ -8828,7 +10700,7 @@ { "name": "thumbnail", "type": "inputThumbnail", - "description": "Document thumbnail, if available" + "description": "Document thumbnail; pass null to skip thumbnail uploading" }, { "name": "disable_content_type_detection", @@ -8838,7 +10710,7 @@ { "name": "caption", "type": "formattedText", - "description": "Document caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "Document caption; pass null to use an empty caption; 0-GetOption(\"message_caption_length_max\") characters" } ], "description": "A document message (general file)", @@ -8853,12 +10725,12 @@ { "name": "photo", "type": "InputFile", - "description": "Photo to send" + "description": "Photo to send. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20" }, { "name": "thumbnail", "type": "inputThumbnail", - "description": "Photo thumbnail to be sent, this is sent to the other party in secret chats only" + "description": "Photo thumbnail to be sent; pass null to skip thumbnail uploading. The thumbnail is sent to the other party only in secret chats" }, { "name": "added_sticker_file_ids", @@ -8878,7 +10750,7 @@ { "name": "caption", "type": "formattedText", - "description": "Photo caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "Photo caption; pass null to use an empty caption; 0-GetOption(\"message_caption_length_max\") characters" }, { "name": "ttl", @@ -8903,7 +10775,7 @@ { "name": "thumbnail", "type": "inputThumbnail", - "description": "Sticker thumbnail, if available" + "description": "Sticker thumbnail; pass null to skip thumbnail uploading" }, { "name": "width", @@ -8914,6 +10786,11 @@ "name": "height", "type": "int32", "description": "Sticker height" + }, + { + "name": "emoji", + "type": "string", + "description": "Emoji used to choose the sticker" } ], "description": "A sticker message", @@ -8933,7 +10810,7 @@ { "name": "thumbnail", "type": "inputThumbnail", - "description": "Video thumbnail, if available" + "description": "Video thumbnail; pass null to skip thumbnail uploading" }, { "name": "added_sticker_file_ids", @@ -8958,12 +10835,12 @@ { "name": "supports_streaming", "type": "Bool", - "description": "True, if the video should be tried to be streamed" + "description": "True, if the video is supposed to be streamed" }, { "name": "caption", "type": "formattedText", - "description": "Video caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "Video caption; pass null to use an empty caption; 0-GetOption(\"message_caption_length_max\") characters" }, { "name": "ttl", @@ -8988,7 +10865,7 @@ { "name": "thumbnail", "type": "inputThumbnail", - "description": "Video thumbnail, if available" + "description": "Video thumbnail; pass null to skip thumbnail uploading" }, { "name": "duration", @@ -9028,7 +10905,7 @@ { "name": "caption", "type": "formattedText", - "description": "Voice note caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "Voice note caption; pass null to use an empty caption; 0-GetOption(\"message_caption_length_max\") characters" } ], "description": "A voice note message", @@ -9048,7 +10925,17 @@ { "name": "live_period", "type": "int32", - "description": "Period for which the location can be updated, in seconds; should be between 60 and 86400 for a live location and 0 otherwise" + "description": "Period for which the location can be updated, in seconds; must be between 60 and 86400 for a live location and 0 otherwise" + }, + { + "name": "heading", + "type": "int32", + "description": "For live locations, a direction in which the location moves, in degrees; 1-360. Pass 0 if unknown" + }, + { + "name": "proximity_alert_radius", + "type": "int32", + "description": "For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled. Can't be enabled in channels and Saved Messages" } ], "description": "A message with a location", @@ -9098,7 +10985,7 @@ { "name": "clear_draft", "type": "Bool", - "description": "True, if a chat message draft should be deleted" + "description": "True, if the chat message draft must be deleted" } ], "description": "A dice message", @@ -9112,7 +10999,7 @@ "methods": [ { "name": "bot_user_id", - "type": "int32", + "type": "int53", "description": "User identifier of the bot that owns the game" }, { @@ -9183,10 +11070,10 @@ { "name": "start_parameter", "type": "string", - "description": "Unique invoice bot start_parameter for the generation of this invoice" + "description": "Unique invoice bot deep link parameter for the generation of this invoice. If empty, it would be possible to pay directly from forwards of the invoice message" } ], - "description": "A message with an invoice; can be used only by bots and only in private chats", + "description": "A message with an invoice; can be used only by bots", "inheritance": "InputMessageContent", "return_type": "", "isFunction": false, @@ -9198,7 +11085,7 @@ { "name": "question", "type": "string", - "description": "Poll question, 1-255 characters (up to 300 characters for bots)" + "description": "Poll question; 1-255 characters (up to 300 characters for bots)" }, { "name": "options", @@ -9223,7 +11110,7 @@ { "name": "close_date", "type": "int32", - "description": "Point in time (Unix timestamp) when the poll will be automatically closed; for bots only" + "description": "Point in time (Unix timestamp) when the poll will automatically be closed; for bots only" }, { "name": "is_closed", @@ -9253,12 +11140,12 @@ { "name": "in_game_share", "type": "Bool", - "description": "True, if a game message should be shared within a launched game; applies only to game messages" + "description": "True, if a game message is being shared from a launched game; applies only to game messages" }, { "name": "copy_options", "type": "messageCopyOptions", - "description": "Options to be used to copy content of the message without a link to the original message" + "description": "Options to be used to copy content of the message without reference to the original sender; pass null to forward the message as usual" } ], "description": "A forwarded message", @@ -9366,24 +11253,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "searchMessagesFilterCall", - "methods": null, - "description": "Returns only call messages", - "inheritance": "SearchMessagesFilter", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "searchMessagesFilterMissedCall", - "methods": null, - "description": "Returns only incoming call messages with missed/declined discard reasons", - "inheritance": "SearchMessagesFilter", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "searchMessagesFilterVideoNote", "methods": null, @@ -9420,6 +11289,15 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "searchMessagesFilterUnreadReaction", + "methods": null, + "description": "Returns only messages with unread reactions for the current user. When using this filter the results can't be additionally filtered by a query, a message thread or by the sending user", + "inheritance": "SearchMessagesFilter", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "searchMessagesFilterFailedToSend", "methods": null, @@ -9429,6 +11307,15 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "searchMessagesFilterPinned", + "methods": null, + "description": "Returns only pinned messages", + "inheritance": "SearchMessagesFilter", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "ChatAction", "methods": null, @@ -9525,6 +11412,15 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatActionChoosingSticker", + "methods": null, + "description": "The user is picking a sticker to send", + "inheritance": "ChatAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatActionChoosingLocation", "methods": null, @@ -9576,10 +11472,25 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatActionWatchingAnimations", + "methods": [ + { + "name": "emoji", + "type": "string", + "description": "The animated emoji" + } + ], + "description": "The user is watching animations sent by the other party by clicking on an animated emoji", + "inheritance": "ChatAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatActionCancel", "methods": null, - "description": "The user has cancelled the previous action", + "description": "The user has canceled the previous action", "inheritance": "ChatAction", "return_type": "", "isFunction": false, @@ -9711,7 +11622,12 @@ { "name": "thumbnail", "type": "thumbnail", - "description": "Sticker set thumbnail in WEBP or TGS format with width and height 100; may be null. The file can be downloaded only before the thumbnail is changed" + "description": "Sticker set thumbnail in WEBP, TGS, or WEBM format with width and height 100; may be null. The file can be downloaded only before the thumbnail is changed" + }, + { + "name": "thumbnail_outline", + "type": "vector", + "description": "Sticker set thumbnail's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner" }, { "name": "is_installed", @@ -9729,14 +11645,14 @@ "description": "True, if the sticker set is official" }, { - "name": "is_animated", - "type": "Bool", - "description": "True, is the stickers in the set are animated" + "name": "sticker_format", + "type": "StickerFormat", + "description": "Format of the stickers in the set" }, { - "name": "is_masks", - "type": "Bool", - "description": "True, if the stickers in the set are masks" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the stickers in the set" }, { "name": "is_viewed", @@ -9781,12 +11697,17 @@ { "name": "thumbnail", "type": "thumbnail", - "description": "Sticker set thumbnail in WEBP or TGS format with width and height 100; may be null" + "description": "Sticker set thumbnail in WEBP, TGS, or WEBM format with width and height 100; may be null" + }, + { + "name": "thumbnail_outline", + "type": "vector", + "description": "Sticker set thumbnail's outline represented as a list of closed vector paths; may be empty. The coordinate system origin is in the upper-left corner" }, { "name": "is_installed", "type": "Bool", - "description": "True, if the sticker set has been installed by current user" + "description": "True, if the sticker set has been installed by the current user" }, { "name": "is_archived", @@ -9799,14 +11720,14 @@ "description": "True, if the sticker set is official" }, { - "name": "is_animated", - "type": "Bool", - "description": "True, is the stickers in the set are animated" + "name": "sticker_format", + "type": "StickerFormat", + "description": "Format of the stickers in the set" }, { - "name": "is_masks", - "type": "Bool", - "description": "True, if the stickers in the set are masks" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the stickers in the set" }, { "name": "is_viewed", @@ -9821,7 +11742,7 @@ { "name": "covers", "type": "vector", - "description": "Contains up to the first 5 stickers from the set, depending on the context. If the application needs more stickers the full set should be requested" + "description": "Up to the first 5 stickers from the set, depending on the context. If the application needs more stickers the full sticker set needs to be requested" } ], "description": "Represents short information about a sticker set", @@ -9850,6 +11771,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "trendingStickerSets", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "Approximate total number of trending sticker sets" + }, + { + "name": "sets", + "type": "vector", + "description": "List of trending sticker sets" + }, + { + "name": "is_premium", + "type": "Bool", + "description": "True, if the list contains sticker sets with premium stickers" + } + ], + "description": "Represents a list of trending sticker sets", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "CallDiscardReason", "methods": null, @@ -9871,7 +11817,7 @@ { "name": "callDiscardReasonMissed", "methods": null, - "description": "The call was ended before the conversation started. It was cancelled by the caller or missed by the other party", + "description": "The call was ended before the conversation started. It was canceled by the caller or missed by the other party", "inheritance": "CallDiscardReason", "return_type": "", "isFunction": false, @@ -9930,7 +11876,7 @@ { "name": "library_versions", "type": "vector", - "description": "List of supported libtgvoip versions" + "description": "List of supported tgcalls versions" } ], "description": "Specifies the supported call protocols", @@ -9955,6 +11901,11 @@ "name": "peer_tag", "type": "bytes", "description": "A peer tag to be used with the reflector" + }, + { + "name": "is_tcp", + "type": "Bool", + "description": "True, if the server uses TCP instead of UDP" } ], "description": "A Telegram call reflector", @@ -10043,6 +11994,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "groupCallId", + "methods": [ + { + "name": "id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Contains the group call identifier", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "CallState", "methods": null, @@ -10141,12 +12107,17 @@ { "name": "need_rating", "type": "Bool", - "description": "True, if the call rating should be sent to the server" + "description": "True, if the call rating must be sent to the server" }, { "name": "need_debug_information", "type": "Bool", - "description": "True, if the call debug information should be sent to the server" + "description": "True, if the call debug information must be sent to the server" + }, + { + "name": "need_log", + "type": "Bool", + "description": "True, if the call log must be sent to the server" } ], "description": "The call has ended successfully", @@ -10170,6 +12141,382 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "GroupCallVideoQuality", + "methods": null, + "description": "Describes the quality of a group call video", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallVideoQualityThumbnail", + "methods": null, + "description": "The worst available video quality", + "inheritance": "GroupCallVideoQuality", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallVideoQualityMedium", + "methods": null, + "description": "The medium video quality", + "inheritance": "GroupCallVideoQuality", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallVideoQualityFull", + "methods": null, + "description": "The best available video quality", + "inheritance": "GroupCallVideoQuality", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallStream", + "methods": [ + { + "name": "channel_id", + "type": "int32", + "description": "Identifier of an audio/video channel" + }, + { + "name": "scale", + "type": "int32", + "description": "Scale of segment durations in the stream. The duration is 1000/(2**scale) milliseconds" + }, + { + "name": "time_offset", + "type": "int53", + "description": "Point in time when the stream currently ends; Unix timestamp in milliseconds" + } + ], + "description": "Describes an available stream in a group call", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallStreams", + "methods": [ + { + "name": "streams", + "type": "vector", + "description": "A list of group call streams" + } + ], + "description": "Represents a list of group call streams", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "rtmpUrl", + "methods": [ + { + "name": "url", + "type": "string", + "description": "The URL" + }, + { + "name": "stream_key", + "type": "string", + "description": "Stream key" + } + ], + "description": "Represents an RTMP url", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallRecentSpeaker", + "methods": [ + { + "name": "participant_id", + "type": "MessageSender", + "description": "Group call participant identifier" + }, + { + "name": "is_speaking", + "type": "Bool", + "description": "True, is the user has spoken recently" + } + ], + "description": "Describes a recently speaking participant in a group call", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCall", + "methods": [ + { + "name": "id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "title", + "type": "string", + "description": "Group call title" + }, + { + "name": "scheduled_start_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the group call is supposed to be started by an administrator; 0 if it is already active or was ended" + }, + { + "name": "enabled_start_notification", + "type": "Bool", + "description": "True, if the group call is scheduled and the current user will receive a notification when the group call will start" + }, + { + "name": "is_active", + "type": "Bool", + "description": "True, if the call is active" + }, + { + "name": "is_rtmp_stream", + "type": "Bool", + "description": "True, if the chat is an RTMP stream instead of an ordinary video chat" + }, + { + "name": "is_joined", + "type": "Bool", + "description": "True, if the call is joined" + }, + { + "name": "need_rejoin", + "type": "Bool", + "description": "True, if user was kicked from the call because of network loss and the call needs to be rejoined" + }, + { + "name": "can_be_managed", + "type": "Bool", + "description": "True, if the current user can manage the group call" + }, + { + "name": "participant_count", + "type": "int32", + "description": "Number of participants in the group call" + }, + { + "name": "has_hidden_listeners", + "type": "Bool", + "description": "True, if group call participants, which are muted, aren't returned in participant list" + }, + { + "name": "loaded_all_participants", + "type": "Bool", + "description": "True, if all group call participants are loaded" + }, + { + "name": "recent_speakers", + "type": "vector", + "description": "At most 3 recently speaking users in the group call" + }, + { + "name": "is_my_video_enabled", + "type": "Bool", + "description": "True, if the current user's video is enabled" + }, + { + "name": "is_my_video_paused", + "type": "Bool", + "description": "True, if the current user's video is paused" + }, + { + "name": "can_enable_video", + "type": "Bool", + "description": "True, if the current user can broadcast video or share screen" + }, + { + "name": "mute_new_participants", + "type": "Bool", + "description": "True, if only group call administrators can unmute new participants" + }, + { + "name": "can_toggle_mute_new_participants", + "type": "Bool", + "description": "True, if the current user can enable or disable mute_new_participants setting" + }, + { + "name": "record_duration", + "type": "int32", + "description": "Duration of the ongoing group call recording, in seconds; 0 if none. An updateGroupCall update is not triggered when value of this field changes, but the same recording goes on" + }, + { + "name": "is_video_recorded", + "type": "Bool", + "description": "True, if a video file is being recorded for the call" + }, + { + "name": "duration", + "type": "int32", + "description": "Call duration, in seconds; for ended calls only" + } + ], + "description": "Describes a group call", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallVideoSourceGroup", + "methods": [ + { + "name": "semantics", + "type": "string", + "description": "The semantics of sources, one of \"SIM\" or \"FID\"" + }, + { + "name": "source_ids", + "type": "vector", + "description": "The list of synchronization source identifiers" + } + ], + "description": "Describes a group of video synchronization source identifiers", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallParticipantVideoInfo", + "methods": [ + { + "name": "source_groups", + "type": "vector", + "description": "List of synchronization source groups of the video" + }, + { + "name": "endpoint_id", + "type": "string", + "description": "Video channel endpoint identifier" + }, + { + "name": "is_paused", + "type": "Bool", + "description": "True if the video is paused. This flag needs to be ignored, if new video frames are received" + } + ], + "description": "Contains information about a group call participant's video channel", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "groupCallParticipant", + "methods": [ + { + "name": "participant_id", + "type": "MessageSender", + "description": "Identifier of the group call participant" + }, + { + "name": "audio_source_id", + "type": "int32", + "description": "User's audio channel synchronization source identifier" + }, + { + "name": "screen_sharing_audio_source_id", + "type": "int32", + "description": "User's screen sharing audio channel synchronization source identifier" + }, + { + "name": "video_info", + "type": "groupCallParticipantVideoInfo", + "description": "Information about user's video channel; may be null if there is no active video" + }, + { + "name": "screen_sharing_video_info", + "type": "groupCallParticipantVideoInfo", + "description": "Information about user's screen sharing video channel; may be null if there is no active screen sharing video" + }, + { + "name": "bio", + "type": "string", + "description": "The participant user's bio or the participant chat's description" + }, + { + "name": "is_current_user", + "type": "Bool", + "description": "True, if the participant is the current user" + }, + { + "name": "is_speaking", + "type": "Bool", + "description": "True, if the participant is speaking as set by setGroupCallParticipantIsSpeaking" + }, + { + "name": "is_hand_raised", + "type": "Bool", + "description": "True, if the participant hand is raised" + }, + { + "name": "can_be_muted_for_all_users", + "type": "Bool", + "description": "True, if the current user can mute the participant for all other group call participants" + }, + { + "name": "can_be_unmuted_for_all_users", + "type": "Bool", + "description": "True, if the current user can allow the participant to unmute themselves or unmute the participant (if the participant is the current user)" + }, + { + "name": "can_be_muted_for_current_user", + "type": "Bool", + "description": "True, if the current user can mute the participant only for self" + }, + { + "name": "can_be_unmuted_for_current_user", + "type": "Bool", + "description": "True, if the current user can unmute the participant for self" + }, + { + "name": "is_muted_for_all_users", + "type": "Bool", + "description": "True, if the participant is muted for all users" + }, + { + "name": "is_muted_for_current_user", + "type": "Bool", + "description": "True, if the participant is muted for the current user" + }, + { + "name": "can_unmute_self", + "type": "Bool", + "description": "True, if the participant is muted for all users, but can unmute themselves" + }, + { + "name": "volume_level", + "type": "int32", + "description": "Participant's volume level; 1-20000 in hundreds of percents" + }, + { + "name": "order", + "type": "string", + "description": "User's order in the group call participant list. Orders must be compared lexicographically. The bigger is order, the higher is user in the list. If order is empty, the user must be removed from the participant list" + } + ], + "description": "Represents a group call participant", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "CallProblem", "methods": null, @@ -10270,7 +12617,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Peer user identifier" }, { @@ -10301,7 +12648,12 @@ { "name": "allow_flash_call", "type": "Bool", - "description": "Pass true if the authentication code may be sent via flash call to the specified phone number" + "description": "Pass true if the authentication code may be sent via a flash call to the specified phone number" + }, + { + "name": "allow_missed_call", + "type": "Bool", + "description": "Pass true if the authentication code may be sent via a missed call to the specified phone number" }, { "name": "is_current_phone_number", @@ -10312,6 +12664,11 @@ "name": "allow_sms_retriever_api", "type": "Bool", "description": "For official applications only. True, if the application can use Android SMS Retriever API (requires Google Play Services >= 10.2) to automatically receive the authentication code from the SMS. See https://developers.google.com/identity/sms-retriever/ for more details" + }, + { + "name": "authentication_tokens", + "type": "vector", + "description": "List of up to 20 authentication tokens, recently received in updateOption(\"authentication_token\") in previously logged out sessions" } ], "description": "Contains settings for the authentication of the user's phone number", @@ -10320,6 +12677,161 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "addedReaction", + "methods": [ + { + "name": "type", + "type": "ReactionType", + "description": "Type of the reaction" + }, + { + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the chat member, applied the reaction" + } + ], + "description": "Represents a reaction applied to a message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "addedReactions", + "methods": [ + { + "name": "total_count", + "type": "int32", + "description": "The total number of found reactions" + }, + { + "name": "reactions", + "type": "vector", + "description": "The list of added reactions" + }, + { + "name": "next_offset", + "type": "string", + "description": "The offset for the next request. If empty, there are no more results" + } + ], + "description": "Represents a list of reactions added to a message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "availableReaction", + "methods": [ + { + "name": "type", + "type": "ReactionType", + "description": "Type of the reaction" + }, + { + "name": "needs_premium", + "type": "Bool", + "description": "True, if Telegram Premium is needed to send the reaction" + } + ], + "description": "Represents an available reaction", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "availableReactions", + "methods": [ + { + "name": "top_reactions", + "type": "vector", + "description": "List of reactions to be shown at the top" + }, + { + "name": "recent_reactions", + "type": "vector", + "description": "List of recently used reactions" + }, + { + "name": "popular_reactions", + "type": "vector", + "description": "List of popular reactions" + }, + { + "name": "allow_custom_emoji", + "type": "Bool", + "description": "True, if custom emoji reactions could be added by Telegram Premium subscribers" + } + ], + "description": "Represents a list of reactions that can be added to a message", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "emojiReaction", + "methods": [ + { + "name": "emoji", + "type": "string", + "description": "Text representation of the reaction" + }, + { + "name": "title", + "type": "string", + "description": "Reaction title" + }, + { + "name": "is_active", + "type": "Bool", + "description": "True, if the reaction can be added to new messages and enabled in chats" + }, + { + "name": "static_icon", + "type": "sticker", + "description": "Static icon for the reaction" + }, + { + "name": "appear_animation", + "type": "sticker", + "description": "Appear animation for the reaction" + }, + { + "name": "select_animation", + "type": "sticker", + "description": "Select animation for the reaction" + }, + { + "name": "activate_animation", + "type": "sticker", + "description": "Activate animation for the reaction" + }, + { + "name": "effect_animation", + "type": "sticker", + "description": "Effect animation for the reaction" + }, + { + "name": "around_animation", + "type": "sticker", + "description": "Around animation for the reaction; may be null" + }, + { + "name": "center_animation", + "type": "sticker", + "description": "Center animation for the reaction; may be null" + } + ], + "description": "Contains information about a emoji reaction", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "animations", "methods": [ @@ -10335,12 +12847,71 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "DiceStickers", + "methods": null, + "description": "Contains animated stickers which must be used for dice animation rendering", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "diceStickersRegular", + "methods": [ + { + "name": "sticker", + "type": "sticker", + "description": "The animated sticker with the dice animation" + } + ], + "description": "A regular animated sticker", + "inheritance": "DiceStickers", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "diceStickersSlotMachine", + "methods": [ + { + "name": "background", + "type": "sticker", + "description": "The animated sticker with the slot machine background. The background animation must start playing after all reel animations finish" + }, + { + "name": "lever", + "type": "sticker", + "description": "The animated sticker with the lever animation. The lever animation must play once in the initial dice state" + }, + { + "name": "left_reel", + "type": "sticker", + "description": "The animated sticker with the left reel" + }, + { + "name": "center_reel", + "type": "sticker", + "description": "The animated sticker with the center reel" + }, + { + "name": "right_reel", + "type": "sticker", + "description": "The animated sticker with the right reel" + } + ], + "description": "Animated stickers to be combined into a slot machine", + "inheritance": "DiceStickers", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "importedContacts", "methods": [ { "name": "user_ids", - "type": "vector", + "type": "vector", "description": "User identifiers of the imported contacts in the same order as they were specified in the request; 0 if the contact is not yet a registered user" }, { @@ -10355,6 +12926,185 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "SpeechRecognitionResult", + "methods": null, + "description": "Describes result of speech recognition in a voice note", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "speechRecognitionResultPending", + "methods": [ + { + "name": "partial_text", + "type": "string", + "description": "Partially recognized text" + } + ], + "description": "The speech recognition is ongoing", + "inheritance": "SpeechRecognitionResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "speechRecognitionResultText", + "methods": [ + { + "name": "text", + "type": "string", + "description": "Recognized text" + } + ], + "description": "The speech recognition successfully finished", + "inheritance": "SpeechRecognitionResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "speechRecognitionResultError", + "methods": [ + { + "name": "error", + "type": "error", + "description": "Received error" + } + ], + "description": "The speech recognition failed", + "inheritance": "SpeechRecognitionResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "attachmentMenuBotColor", + "methods": [ + { + "name": "light_color", + "type": "int32", + "description": "Color in the RGB24 format for light themes" + }, + { + "name": "dark_color", + "type": "int32", + "description": "Color in the RGB24 format for dark themes" + } + ], + "description": "Describes a color to highlight a bot added to attachment menu", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "attachmentMenuBot", + "methods": [ + { + "name": "bot_user_id", + "type": "int53", + "description": "User identifier of the bot added to attachment menu" + }, + { + "name": "supports_self_chat", + "type": "Bool", + "description": "True, if the bot supports opening from attachment menu in the chat with the bot" + }, + { + "name": "supports_user_chats", + "type": "Bool", + "description": "True, if the bot supports opening from attachment menu in private chats with ordinary users" + }, + { + "name": "supports_bot_chats", + "type": "Bool", + "description": "True, if the bot supports opening from attachment menu in private chats with other bots" + }, + { + "name": "supports_group_chats", + "type": "Bool", + "description": "True, if the bot supports opening from attachment menu in basic group and supergroup chats" + }, + { + "name": "supports_channel_chats", + "type": "Bool", + "description": "True, if the bot supports opening from attachment menu in channel chats" + }, + { + "name": "supports_settings", + "type": "Bool", + "description": "True, if the bot supports \"settings_button_pressed\" event" + }, + { + "name": "name", + "type": "string", + "description": "Name for the bot in attachment menu" + }, + { + "name": "name_color", + "type": "attachmentMenuBotColor", + "description": "Color to highlight selected name of the bot if appropriate; may be null" + }, + { + "name": "default_icon", + "type": "file", + "description": "Default attachment menu icon for the bot in SVG format; may be null" + }, + { + "name": "ios_static_icon", + "type": "file", + "description": "Attachment menu icon for the bot in SVG format for the official iOS app; may be null" + }, + { + "name": "ios_animated_icon", + "type": "file", + "description": "Attachment menu icon for the bot in TGS format for the official iOS app; may be null" + }, + { + "name": "android_icon", + "type": "file", + "description": "Attachment menu icon for the bot in TGS format for the official Android app; may be null" + }, + { + "name": "macos_icon", + "type": "file", + "description": "Attachment menu icon for the bot in TGS format for the official native macOS app; may be null" + }, + { + "name": "icon_color", + "type": "attachmentMenuBotColor", + "description": "Color to highlight selected icon of the bot if appropriate; may be null" + }, + { + "name": "web_app_placeholder", + "type": "file", + "description": "Default placeholder for opened Web Apps in SVG format; may be null" + } + ], + "description": "Represents a bot added to attachment menu", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sentWebAppMessage", + "methods": [ + { + "name": "inline_message_id", + "type": "string", + "description": "Identifier of the sent inline message, if known" + } + ], + "description": "Information about the message sent by answerWebAppQuery", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "httpUrl", "methods": [ @@ -10430,15 +13180,15 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageAnimation, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAnimation, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], - "description": "Represents a link to an animated GIF or an animated (i.e. without sound) H.264/MPEG-4 AVC video", + "description": "Represents a link to an animated GIF or an animated (i.e., without sound) H.264/MPEG-4 AVC video", "inheritance": "InputInlineQueryResult", "return_type": "", "isFunction": false, @@ -10490,12 +13240,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a link to an article or web page", @@ -10535,12 +13285,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageAudio, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageAudio, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a link to an MP3 audio file", @@ -10580,12 +13330,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a user contact", @@ -10640,12 +13390,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageDocument, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageDocument, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a link to a file", @@ -10670,7 +13420,7 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "Message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" } ], "description": "Represents a game", @@ -10720,12 +13470,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a point on the map", @@ -10775,12 +13525,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessagePhoto, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessagePhoto, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents link to a JPEG image", @@ -10805,7 +13555,7 @@ { "name": "sticker_url", "type": "string", - "description": "The URL of the WEBP or TGS sticker (sticker file size must not exceed 5MB)" + "description": "The URL of the WEBP, TGS, or WEBM sticker (sticker file size must not exceed 5MB)" }, { "name": "sticker_width", @@ -10820,15 +13570,15 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, inputMessageSticker, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageSticker, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], - "description": "Represents a link to a WEBP or TGS sticker", + "description": "Represents a link to a WEBP, TGS, or WEBM sticker", "inheritance": "InputInlineQueryResult", "return_type": "", "isFunction": false, @@ -10865,12 +13615,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents information about a venue", @@ -10930,12 +13680,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageVideo, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageVideo, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a link to a page containing an embedded video player or a video file", @@ -10970,12 +13720,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The message reply markup. Must be of type replyMarkupInlineKeyboard or null" + "description": "The message reply markup; pass null if none. Must be of type replyMarkupInlineKeyboard or null" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "The content of the message to be sent. Must be one of the following types: InputMessageText, InputMessageVoiceNote, InputMessageLocation, InputMessageVenue or InputMessageContact" + "description": "The content of the message to be sent. Must be one of the following types: inputMessageText, inputMessageVoiceNote, inputMessageInvoice, inputMessageLocation, inputMessageVenue or inputMessageContact" } ], "description": "Represents a link to an opus-encoded audio file within an OGG container, single channel audio", @@ -11334,7 +14084,7 @@ { "name": "switch_pm_text", "type": "string", - "description": "If non-empty, this text should be shown on the button, which opens a private chat with the bot and sends the bot a start message with the switch_pm_parameter" + "description": "If non-empty, this text must be shown on the button, which opens a private chat with the bot and sends the bot a start message with the switch_pm_parameter" }, { "name": "switch_pm_parameter", @@ -11378,7 +14128,7 @@ { "name": "password", "type": "string", - "description": "The password for the current user" + "description": "The 2-step verification password for the current user" }, { "name": "data", @@ -11418,7 +14168,7 @@ { "name": "show_alert", "type": "Bool", - "description": "True, if an alert should be shown to the user instead of a toast notification" + "description": "True, if an alert must be shown to the user instead of a toast notification" }, { "name": "url", @@ -11457,7 +14207,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -11531,21 +14281,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "chatEventPollStopped", - "methods": [ - { - "name": "message", - "type": "message", - "description": "The message with the poll" - } - ], - "description": "A poll in a message was stopped", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "chatEventMessagePinned", "methods": [ @@ -11563,13 +14298,34 @@ }, { "name": "chatEventMessageUnpinned", - "methods": null, + "methods": [ + { + "name": "message", + "type": "message", + "description": "Unpinned message" + } + ], "description": "A message was unpinned", "inheritance": "ChatEventAction", "return_type": "", "isFunction": false, "isSynchronous": false }, + { + "name": "chatEventPollStopped", + "methods": [ + { + "name": "message", + "type": "message", + "description": "The message with the poll" + } + ], + "description": "A poll in a message was stopped", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatEventMemberJoined", "methods": null, @@ -11580,9 +14336,35 @@ "isSynchronous": false }, { - "name": "chatEventMemberLeft", - "methods": null, - "description": "A member left the chat", + "name": "chatEventMemberJoinedByInviteLink", + "methods": [ + { + "name": "invite_link", + "type": "chatInviteLink", + "description": "Invite link used to join the chat" + } + ], + "description": "A new member joined the chat via an invite link", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventMemberJoinedByRequest", + "methods": [ + { + "name": "approver_user_id", + "type": "int53", + "description": "User identifier of the chat administrator, approved user join request" + }, + { + "name": "invite_link", + "type": "chatInviteLink", + "description": "Invite link used to join the chat; may be null" + } + ], + "description": "A new member was accepted to the chat by an administrator", "inheritance": "ChatEventAction", "return_type": "", "isFunction": false, @@ -11593,7 +14375,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "New member user identifier" }, { @@ -11608,13 +14390,22 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatEventMemberLeft", + "methods": null, + "description": "A member left the chat", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatEventMemberPromoted", "methods": [ { "name": "user_id", - "type": "int32", - "description": "Chat member user identifier" + "type": "int53", + "description": "Affected chat member user identifier" }, { "name": "old_status", @@ -11637,9 +14428,9 @@ "name": "chatEventMemberRestricted", "methods": [ { - "name": "user_id", - "type": "int32", - "description": "Chat member user identifier" + "name": "member_id", + "type": "MessageSender", + "description": "Affected chat member identifier" }, { "name": "old_status", @@ -11659,40 +14450,20 @@ "isSynchronous": false }, { - "name": "chatEventTitleChanged", + "name": "chatEventAvailableReactionsChanged", "methods": [ { - "name": "old_title", - "type": "string", - "description": "Previous chat title" + "name": "old_available_reactions", + "type": "ChatAvailableReactions", + "description": "Previous chat available reactions" }, { - "name": "new_title", - "type": "string", - "description": "New chat title" + "name": "new_available_reactions", + "type": "ChatAvailableReactions", + "description": "New chat available reactions" } ], - "description": "The chat title was changed", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatEventPermissionsChanged", - "methods": [ - { - "name": "old_permissions", - "type": "chatPermissions", - "description": "Previous chat permissions" - }, - { - "name": "new_permissions", - "type": "chatPermissions", - "description": "New chat permissions" - } - ], - "description": "The chat permissions was changed", + "description": "The chat available reactions were changed", "inheritance": "ChatEventAction", "return_type": "", "isFunction": false, @@ -11718,61 +14489,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "chatEventUsernameChanged", - "methods": [ - { - "name": "old_username", - "type": "string", - "description": "Previous chat username" - }, - { - "name": "new_username", - "type": "string", - "description": "New chat username" - } - ], - "description": "The chat username was changed", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatEventPhotoChanged", - "methods": [ - { - "name": "old_photo", - "type": "chatPhoto", - "description": "Previous chat photo value; may be null" - }, - { - "name": "new_photo", - "type": "chatPhoto", - "description": "New chat photo value; may be null" - } - ], - "description": "The chat photo was changed", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatEventInvitesToggled", - "methods": [ - { - "name": "can_invite_users", - "type": "Bool", - "description": "New value of can_invite_users permission" - } - ], - "description": "The can_invite_users permission of a supergroup chat was toggled", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "chatEventLinkedChatChanged", "methods": [ @@ -11793,61 +14509,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "chatEventSlowModeDelayChanged", - "methods": [ - { - "name": "old_slow_mode_delay", - "type": "int32", - "description": "Previous value of slow_mode_delay" - }, - { - "name": "new_slow_mode_delay", - "type": "int32", - "description": "New value of slow_mode_delay" - } - ], - "description": "The slow_mode_delay setting of a supergroup was changed", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatEventSignMessagesToggled", - "methods": [ - { - "name": "sign_messages", - "type": "Bool", - "description": "New value of sign_messages" - } - ], - "description": "The sign_messages setting of a channel was toggled", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "chatEventStickerSetChanged", - "methods": [ - { - "name": "old_sticker_set_id", - "type": "int64", - "description": "Previous identifier of the chat sticker set; 0 if none" - }, - { - "name": "new_sticker_set_id", - "type": "int64", - "description": "New identifier of the chat sticker set; 0 if none" - } - ], - "description": "The supergroup sticker set was changed", - "inheritance": "ChatEventAction", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "chatEventLocationChanged", "methods": [ @@ -11868,6 +14529,176 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatEventMessageTtlChanged", + "methods": [ + { + "name": "old_message_ttl", + "type": "int32", + "description": "Previous value of message_ttl" + }, + { + "name": "new_message_ttl", + "type": "int32", + "description": "New value of message_ttl" + } + ], + "description": "The message TTL was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventPermissionsChanged", + "methods": [ + { + "name": "old_permissions", + "type": "chatPermissions", + "description": "Previous chat permissions" + }, + { + "name": "new_permissions", + "type": "chatPermissions", + "description": "New chat permissions" + } + ], + "description": "The chat permissions was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventPhotoChanged", + "methods": [ + { + "name": "old_photo", + "type": "chatPhoto", + "description": "Previous chat photo value; may be null" + }, + { + "name": "new_photo", + "type": "chatPhoto", + "description": "New chat photo value; may be null" + } + ], + "description": "The chat photo was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventSlowModeDelayChanged", + "methods": [ + { + "name": "old_slow_mode_delay", + "type": "int32", + "description": "Previous value of slow_mode_delay, in seconds" + }, + { + "name": "new_slow_mode_delay", + "type": "int32", + "description": "New value of slow_mode_delay, in seconds" + } + ], + "description": "The slow_mode_delay setting of a supergroup was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventStickerSetChanged", + "methods": [ + { + "name": "old_sticker_set_id", + "type": "int64", + "description": "Previous identifier of the chat sticker set; 0 if none" + }, + { + "name": "new_sticker_set_id", + "type": "int64", + "description": "New identifier of the chat sticker set; 0 if none" + } + ], + "description": "The supergroup sticker set was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventTitleChanged", + "methods": [ + { + "name": "old_title", + "type": "string", + "description": "Previous chat title" + }, + { + "name": "new_title", + "type": "string", + "description": "New chat title" + } + ], + "description": "The chat title was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventUsernameChanged", + "methods": [ + { + "name": "old_username", + "type": "string", + "description": "Previous chat username" + }, + { + "name": "new_username", + "type": "string", + "description": "New chat username" + } + ], + "description": "The chat username was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventHasProtectedContentToggled", + "methods": [ + { + "name": "has_protected_content", + "type": "Bool", + "description": "New value of has_protected_content" + } + ], + "description": "The has_protected_content setting of a channel was toggled", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventInvitesToggled", + "methods": [ + { + "name": "can_invite_users", + "type": "Bool", + "description": "New value of can_invite_users permission" + } + ], + "description": "The can_invite_users permission of a supergroup chat was toggled", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatEventIsAllHistoryAvailableToggled", "methods": [ @@ -11883,6 +14714,156 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatEventSignMessagesToggled", + "methods": [ + { + "name": "sign_messages", + "type": "Bool", + "description": "New value of sign_messages" + } + ], + "description": "The sign_messages setting of a channel was toggled", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventInviteLinkEdited", + "methods": [ + { + "name": "old_invite_link", + "type": "chatInviteLink", + "description": "Previous information about the invite link" + }, + { + "name": "new_invite_link", + "type": "chatInviteLink", + "description": "New information about the invite link" + } + ], + "description": "A chat invite link was edited", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventInviteLinkRevoked", + "methods": [ + { + "name": "invite_link", + "type": "chatInviteLink", + "description": "The invite link" + } + ], + "description": "A chat invite link was revoked", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventInviteLinkDeleted", + "methods": [ + { + "name": "invite_link", + "type": "chatInviteLink", + "description": "The invite link" + } + ], + "description": "A revoked chat invite link was deleted", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventVideoChatCreated", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall" + } + ], + "description": "A video chat was created", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventVideoChatEnded", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Identifier of the video chat. The video chat can be received through the method getGroupCall" + } + ], + "description": "A video chat was ended", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventVideoChatMuteNewParticipantsToggled", + "methods": [ + { + "name": "mute_new_participants", + "type": "Bool", + "description": "New value of the mute_new_participants setting" + } + ], + "description": "The mute_new_participants setting of a video chat was toggled", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventVideoChatParticipantIsMutedToggled", + "methods": [ + { + "name": "participant_id", + "type": "MessageSender", + "description": "Identifier of the affected group call participant" + }, + { + "name": "is_muted", + "type": "Bool", + "description": "New value of is_muted" + } + ], + "description": "A video chat participant was muted or unmuted", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatEventVideoChatParticipantVolumeLevelChanged", + "methods": [ + { + "name": "participant_id", + "type": "MessageSender", + "description": "Identifier of the affected group call participant" + }, + { + "name": "volume_level", + "type": "int32", + "description": "New value of volume_level; 1-20000 in hundreds of percents" + } + ], + "description": "A video chat participant volume level was changed", + "inheritance": "ChatEventAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatEvent", "methods": [ @@ -11897,14 +14878,14 @@ "description": "Point in time (Unix timestamp) when the event happened" }, { - "name": "user_id", - "type": "int32", - "description": "Identifier of the user who performed the action that triggered the event" + "name": "member_id", + "type": "MessageSender", + "description": "Identifier of the user or chat who performed the action" }, { "name": "action", "type": "ChatEventAction", - "description": "Action performed by the user" + "description": "The action" } ], "description": "Represents a chat event", @@ -11934,52 +14915,62 @@ { "name": "message_edits", "type": "Bool", - "description": "True, if message edits should be returned" + "description": "True, if message edits need to be returned" }, { "name": "message_deletions", "type": "Bool", - "description": "True, if message deletions should be returned" + "description": "True, if message deletions need to be returned" }, { "name": "message_pins", "type": "Bool", - "description": "True, if pin/unpin events should be returned" + "description": "True, if pin/unpin events need to be returned" }, { "name": "member_joins", "type": "Bool", - "description": "True, if members joining events should be returned" + "description": "True, if members joining events need to be returned" }, { "name": "member_leaves", "type": "Bool", - "description": "True, if members leaving events should be returned" + "description": "True, if members leaving events need to be returned" }, { "name": "member_invites", "type": "Bool", - "description": "True, if invited member events should be returned" + "description": "True, if invited member events need to be returned" }, { "name": "member_promotions", "type": "Bool", - "description": "True, if member promotion/demotion events should be returned" + "description": "True, if member promotion/demotion events need to be returned" }, { "name": "member_restrictions", "type": "Bool", - "description": "True, if member restricted/unrestricted/banned/unbanned events should be returned" + "description": "True, if member restricted/unrestricted/banned/unbanned events need to be returned" }, { "name": "info_changes", "type": "Bool", - "description": "True, if changes in chat information should be returned" + "description": "True, if changes in chat information need to be returned" }, { "name": "setting_changes", "type": "Bool", - "description": "True, if changes in chat settings should be returned" + "description": "True, if changes in chat settings need to be returned" + }, + { + "name": "invite_link_changes", + "type": "Bool", + "description": "True, if changes to invite links need to be returned" + }, + { + "name": "video_chat_changes", + "type": "Bool", + "description": "True, if video chat actions need to be returned" } ], "description": "Represents a set of filters used to obtain a chat event log", @@ -12046,7 +15037,7 @@ "description": "Default value" } ], - "description": "A language pack string which has different forms based on the number of some object it mentions. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info", + "description": "A language pack string which has different forms based on the number of some object it mentions. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information", "inheritance": "LanguagePackStringValue", "return_type": "", "isFunction": false, @@ -12055,7 +15046,7 @@ { "name": "languagePackStringValueDeleted", "methods": null, - "description": "A deleted language pack string, the value should be taken from the built-in english language pack", + "description": "A deleted language pack string, the value must be taken from the built-in English language pack", "inheritance": "LanguagePackStringValue", "return_type": "", "isFunction": false, @@ -12072,7 +15063,7 @@ { "name": "value", "type": "LanguagePackStringValue", - "description": "String value" + "description": "String value; pass null if the string needs to be taken from the built-in English language pack" } ], "description": "Represents one language pack string", @@ -12107,7 +15098,7 @@ { "name": "base_language_pack_id", "type": "string", - "description": "Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it should be fetched from base language pack. Unsupported in custom language packs" + "description": "Identifier of a base language pack; may be empty. If a string is missed in the language pack, then it must be fetched from base language pack. Unsupported in custom language packs" }, { "name": "name", @@ -12122,7 +15113,7 @@ { "name": "plural_code", "type": "string", - "description": "A language code to be used to apply plural forms. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more info" + "description": "A language code to be used to apply plural forms. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html for more information" }, { "name": "is_official", @@ -12186,6 +15177,438 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "PremiumLimitType", + "methods": null, + "description": "Describes type of a limit, increased for Premium users", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeSupergroupCount", + "methods": null, + "description": "The maximum number of joined supergroups and channels", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypePinnedChatCount", + "methods": null, + "description": "The maximum number of pinned chats in the main chat list", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeCreatedPublicChatCount", + "methods": null, + "description": "The maximum number of created public chats", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeSavedAnimationCount", + "methods": null, + "description": "The maximum number of saved animations", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeFavoriteStickerCount", + "methods": null, + "description": "The maximum number of favorite stickers", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeChatFilterCount", + "methods": null, + "description": "The maximum number of chat filters", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeChatFilterChosenChatCount", + "methods": null, + "description": "The maximum number of pinned and always included, or always excluded chats in a chat filter", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypePinnedArchivedChatCount", + "methods": null, + "description": "The maximum number of pinned chats in the archive chat list", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeCaptionLength", + "methods": null, + "description": "The maximum length of sent media caption", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimitTypeBioLength", + "methods": null, + "description": "The maximum length of the user's bio", + "inheritance": "PremiumLimitType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "PremiumFeature", + "methods": null, + "description": "Describes a feature available to Premium users", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureIncreasedLimits", + "methods": null, + "description": "Increased limits", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureIncreasedUploadFileSize", + "methods": null, + "description": "Increased maximum upload file size", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureImprovedDownloadSpeed", + "methods": null, + "description": "Improved download speed", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureVoiceRecognition", + "methods": null, + "description": "The ability to convert voice notes to text", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureDisabledAds", + "methods": null, + "description": "Disabled ads", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureUniqueReactions", + "methods": null, + "description": "Allowed to use more reactions", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureUniqueStickers", + "methods": null, + "description": "Allowed to use premium stickers with unique effects", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureCustomEmoji", + "methods": null, + "description": "Allowed to use custom emoji stickers in message texts and captions", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureAdvancedChatManagement", + "methods": null, + "description": "Ability to change position of the main chat list, archive and mute all new chats from non-contacts, and completely disable notifications about the user's contacts joined Telegram", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureProfileBadge", + "methods": null, + "description": "A badge in the user's profile", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureEmojiStatus", + "methods": null, + "description": "A emoji status shown along with the user's name", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureAnimatedProfilePhoto", + "methods": null, + "description": "Profile photo animation on message and chat screens", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatureAppIcons", + "methods": null, + "description": "Allowed to set a premium appllication icons", + "inheritance": "PremiumFeature", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumLimit", + "methods": [ + { + "name": "type", + "type": "PremiumLimitType", + "description": "The type of the limit" + }, + { + "name": "default_value", + "type": "int32", + "description": "Default value of the limit" + }, + { + "name": "premium_value", + "type": "int32", + "description": "Value of the limit for Premium users" + } + ], + "description": "Contains information about a limit, increased for Premium users", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeatures", + "methods": [ + { + "name": "features", + "type": "vector", + "description": "The list of available features" + }, + { + "name": "limits", + "type": "vector", + "description": "The list of limits, increased for Premium users" + }, + { + "name": "payment_link", + "type": "InternalLinkType", + "description": "An internal link to be opened to pay for Telegram Premium if store payment isn't possible; may be null if direct payment isn't available" + } + ], + "description": "Contains information about features, available to Premium users", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "PremiumSource", + "methods": null, + "description": "Describes a source from which the Premium features screen is opened", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumSourceLimitExceeded", + "methods": [ + { + "name": "limit_type", + "type": "PremiumLimitType", + "description": "Type of the exceeded limit" + } + ], + "description": "A limit was exceeded", + "inheritance": "PremiumSource", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumSourceFeature", + "methods": [ + { + "name": "feature", + "type": "PremiumFeature", + "description": "The used feature" + } + ], + "description": "A user tried to use a Premium feature", + "inheritance": "PremiumSource", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumSourceLink", + "methods": [ + { + "name": "referrer", + "type": "string", + "description": "The referrer from the link" + } + ], + "description": "A user opened an internal link of the type internalLinkTypePremiumFeatures", + "inheritance": "PremiumSource", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumSourceSettings", + "methods": null, + "description": "A user opened the Premium features screen from settings", + "inheritance": "PremiumSource", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumFeaturePromotionAnimation", + "methods": [ + { + "name": "feature", + "type": "PremiumFeature", + "description": "Premium feature" + }, + { + "name": "animation", + "type": "animation", + "description": "Promotion animation for the feature" + } + ], + "description": "Describes a promotion animation for a Premium feature", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "premiumState", + "methods": [ + { + "name": "state", + "type": "formattedText", + "description": "Text description of the state of the current Premium subscription; may be empty if the current user has no Telegram Premium subscription" + }, + { + "name": "payment_options", + "type": "vector", + "description": "The list of available options for buying Telegram Premium" + }, + { + "name": "animations", + "type": "vector", + "description": "The list of available promotion animations for Premium features" + } + ], + "description": "Contains state of Telegram Premium subscription and promotion videos for Premium features", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "StorePaymentPurpose", + "methods": null, + "description": "Describes a purpose of an in-store payment", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "storePaymentPurposePremiumSubscription", + "methods": [ + { + "name": "is_restore", + "type": "Bool", + "description": "Pass true if this is a restore of a Telegram Premium purchase; only for App Store" + } + ], + "description": "The user subscribed to Telegram Premium", + "inheritance": "StorePaymentPurpose", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "storePaymentPurposeGiftedPremium", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "Identifier of the user for which Premium was gifted" + }, + { + "name": "currency", + "type": "string", + "description": "ISO 4217 currency code of the payment currency" + }, + { + "name": "amount", + "type": "int53", + "description": "Paid amount, in the smallest units of the currency" + } + ], + "description": "The user gifted Telegram Premium to another user", + "inheritance": "StorePaymentPurpose", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "DeviceToken", "methods": null, @@ -12201,12 +15624,12 @@ { "name": "token", "type": "string", - "description": "Device registration token; may be empty to de-register a device" + "description": "Device registration token; may be empty to deregister a device" }, { "name": "encrypt", "type": "Bool", - "description": "True, if push notifications should be additionally encrypted" + "description": "True, if push notifications must be additionally encrypted" } ], "description": "A token for Firebase Cloud Messaging", @@ -12221,7 +15644,7 @@ { "name": "device_token", "type": "string", - "description": "Device token; may be empty to de-register a device" + "description": "Device token; may be empty to deregister a device" }, { "name": "is_app_sandbox", @@ -12241,7 +15664,7 @@ { "name": "device_token", "type": "string", - "description": "Device token; may be empty to de-register a device" + "description": "Device token; may be empty to deregister a device" }, { "name": "is_app_sandbox", @@ -12251,7 +15674,7 @@ { "name": "encrypt", "type": "Bool", - "description": "True, if push notifications should be additionally encrypted" + "description": "True, if push notifications must be additionally encrypted" } ], "description": "A token for Apple Push Notification service VoIP notifications", @@ -12266,7 +15689,7 @@ { "name": "access_token", "type": "string", - "description": "The access token that will be used to send notifications; may be empty to de-register a device" + "description": "The access token that will be used to send notifications; may be empty to deregister a device" } ], "description": "A token for Windows Push Notification Services", @@ -12281,7 +15704,7 @@ { "name": "channel_uri", "type": "string", - "description": "Push notification channel URI; may be empty to de-register a device" + "description": "Push notification channel URI; may be empty to deregister a device" } ], "description": "A token for Microsoft Push Notification Service", @@ -12296,7 +15719,7 @@ { "name": "channel_uri", "type": "string", - "description": "Push notification channel URI; may be empty to de-register a device" + "description": "Push notification channel URI; may be empty to deregister a device" } ], "description": "A token for Microsoft Push Notification Service VoIP channel", @@ -12311,7 +15734,7 @@ { "name": "endpoint", "type": "string", - "description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to de-register a device" + "description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to deregister a device" }, { "name": "p256dh_base64url", @@ -12336,7 +15759,7 @@ { "name": "endpoint", "type": "string", - "description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to de-register a device" + "description": "Absolute URL exposed by the push service where the application server can send push messages; may be empty to deregister a device" } ], "description": "A token for Simple Push API for Firefox OS", @@ -12351,7 +15774,7 @@ { "name": "token", "type": "string", - "description": "Token; may be empty to de-register a device" + "description": "Token; may be empty to deregister a device" } ], "description": "A token for Ubuntu Push Client service", @@ -12366,7 +15789,7 @@ { "name": "token", "type": "string", - "description": "Token; may be empty to de-register a device" + "description": "Token; may be empty to deregister a device" } ], "description": "A token for BlackBerry Push Service", @@ -12381,7 +15804,7 @@ { "name": "reg_id", "type": "string", - "description": "Push service registration identifier; may be empty to de-register a device" + "description": "Push service registration identifier; may be empty to deregister a device" } ], "description": "A token for Tizen Push Service", @@ -12445,7 +15868,7 @@ { "name": "rotation_angle", "type": "int32", - "description": "Clockwise rotation angle of the gradient, in degrees; 0-359. Should be always divisible by 45" + "description": "Clockwise rotation angle of the gradient, in degrees; 0-359. Must be always divisible by 45" } ], "description": "Describes a gradient fill of a background", @@ -12454,6 +15877,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "backgroundFillFreeformGradient", + "methods": [ + { + "name": "colors", + "type": "vector", + "description": "A list of 3 or 4 colors of the freeform gradients in the RGB24 format" + } + ], + "description": "Describes a freeform gradient fill of a background", + "inheritance": "BackgroundFill", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "BackgroundType", "methods": null, @@ -12489,12 +15927,17 @@ { "name": "fill", "type": "BackgroundFill", - "description": "Description of the background fill" + "description": "Fill of the background" }, { "name": "intensity", "type": "int32", - "description": "Intensity of the pattern when it is shown above the filled background, 0-100" + "description": "Intensity of the pattern when it is shown above the filled background; 0-100." + }, + { + "name": "is_inverted", + "type": "Bool", + "description": "True, if the background fill must be applied only to the pattern itself. All other pixels are black in this case. For dark themes only" }, { "name": "is_moving", @@ -12514,7 +15957,7 @@ { "name": "fill", "type": "BackgroundFill", - "description": "Description of the background fill" + "description": "The background fill" } ], "description": "A filled background", @@ -12617,6 +16060,66 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "themeSettings", + "methods": [ + { + "name": "accent_color", + "type": "int32", + "description": "Theme accent color in ARGB format" + }, + { + "name": "background", + "type": "background", + "description": "The background to be used in chats; may be null" + }, + { + "name": "outgoing_message_fill", + "type": "BackgroundFill", + "description": "The fill to be used as a background for outgoing messages" + }, + { + "name": "animate_outgoing_message_fill", + "type": "Bool", + "description": "If true, the freeform gradient fill needs to be animated on every sent message" + }, + { + "name": "outgoing_message_accent_color", + "type": "int32", + "description": "Accent color of outgoing messages in ARGB format" + } + ], + "description": "Describes theme settings", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatTheme", + "methods": [ + { + "name": "name", + "type": "string", + "description": "Theme name" + }, + { + "name": "light_settings", + "type": "themeSettings", + "description": "Theme settings for a light chat theme" + }, + { + "name": "dark_settings", + "type": "themeSettings", + "description": "Theme settings for a dark chat theme" + } + ], + "description": "Describes a chat theme", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "hashtags", "methods": [ @@ -12728,7 +16231,7 @@ { "name": "checkChatUsernameResultPublicChatsTooMuch", "methods": null, - "description": "The user has too much chats with username, one of them should be made private first", + "description": "The user has too many chats with username, one of them must be made private first", "inheritance": "CheckChatUsernameResult", "return_type": "", "isFunction": false, @@ -12743,6 +16246,138 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "CheckStickerSetNameResult", + "methods": null, + "description": "Represents result of checking whether a name can be used for a new sticker set", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "checkStickerSetNameResultOk", + "methods": null, + "description": "The name can be set", + "inheritance": "CheckStickerSetNameResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "checkStickerSetNameResultNameInvalid", + "methods": null, + "description": "The name is invalid", + "inheritance": "CheckStickerSetNameResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "checkStickerSetNameResultNameOccupied", + "methods": null, + "description": "The name is occupied", + "inheritance": "CheckStickerSetNameResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "ResetPasswordResult", + "methods": null, + "description": "Represents result of 2-step verification password reset", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "resetPasswordResultOk", + "methods": null, + "description": "The password was reset", + "inheritance": "ResetPasswordResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "resetPasswordResultPending", + "methods": [ + { + "name": "pending_reset_date", + "type": "int32", + "description": "Point in time (Unix timestamp) after which the password can be reset immediately using resetPassword" + } + ], + "description": "The password reset request is pending", + "inheritance": "ResetPasswordResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "resetPasswordResultDeclined", + "methods": [ + { + "name": "retry_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the password reset can be retried" + } + ], + "description": "The password reset request was declined", + "inheritance": "ResetPasswordResult", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "MessageFileType", + "methods": null, + "description": "Contains information about a file with messages exported from another app", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageFileTypePrivate", + "methods": [ + { + "name": "name", + "type": "string", + "description": "Name of the other party; may be empty if unrecognized" + } + ], + "description": "The messages was exported from a private chat", + "inheritance": "MessageFileType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageFileTypeGroup", + "methods": [ + { + "name": "title", + "type": "string", + "description": "Title of the group chat; may be empty if unrecognized" + } + ], + "description": "The messages was exported from a group chat", + "inheritance": "MessageFileType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "messageFileTypeUnknown", + "methods": null, + "description": "The messages was exported from a chat of unknown type", + "inheritance": "MessageFileType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "PushMessageContent", "methods": null, @@ -13150,7 +16785,7 @@ { "name": "is_returned", "type": "Bool", - "description": "True, if the user has returned to the group themself" + "description": "True, if the user has returned to the group themselves" } ], "description": "New chat members were invited to a group", @@ -13183,6 +16818,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "pushMessageContentChatSetTheme", + "methods": [ + { + "name": "theme_name", + "type": "string", + "description": "If non-empty, name of a new theme, set for the chat. Otherwise chat theme was reset to the default one" + } + ], + "description": "A chat theme was edited", + "inheritance": "PushMessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "pushMessageContentChatDeleteMember", "methods": [ @@ -13199,7 +16849,7 @@ { "name": "is_left", "type": "Bool", - "description": "True, if the user has left the group themself" + "description": "True, if the user has left the group themselves" } ], "description": "A chat member was deleted", @@ -13211,7 +16861,31 @@ { "name": "pushMessageContentChatJoinByLink", "methods": null, - "description": "A new member joined the chat by invite link", + "description": "A new member joined the chat via an invite link", + "inheritance": "PushMessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "pushMessageContentChatJoinByRequest", + "methods": null, + "description": "A new member was accepted to the chat by an administrator", + "inheritance": "PushMessageContent", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "pushMessageContentRecurringPayment", + "methods": [ + { + "name": "amount", + "type": "string", + "description": "The paid amount" + } + ], + "description": "A new recurrent payment was made by the current user", "inheritance": "PushMessageContent", "return_type": "", "isFunction": false, @@ -13249,6 +16923,16 @@ "name": "has_videos", "type": "Bool", "description": "True, if the album has at least one video" + }, + { + "name": "has_audios", + "type": "Bool", + "description": "True, if the album has at least one audio file" + }, + { + "name": "has_documents", + "type": "Bool", + "description": "True, if the album has at least one document" } ], "description": "A media album", @@ -13273,6 +16957,11 @@ "name": "message", "type": "message", "description": "The message" + }, + { + "name": "show_preview", + "type": "Bool", + "description": "True, if message content must be displayed in notifications" } ], "description": "New message was received", @@ -13314,19 +17003,14 @@ "description": "The message identifier. The message will not be available in the chat history, but the ID can be used in viewMessages, or as reply_to_message_id" }, { - "name": "sender_user_id", - "type": "int32", - "description": "Sender of the message; 0 if unknown. Corresponding user may be inaccessible" - }, - { - "name": "sender_chat_id", - "type": "int53", - "description": "Sender chat of the message; 0 if none" + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender of the message. Corresponding user or chat may be inaccessible" }, { "name": "sender_name", "type": "string", - "description": "Name of the sender; can be different from the name of the sender user" + "description": "Name of the sender" }, { "name": "is_outgoing", @@ -13390,6 +17074,61 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "notificationSound", + "methods": [ + { + "name": "id", + "type": "int64", + "description": "Unique identifier of the notification sound" + }, + { + "name": "duration", + "type": "int32", + "description": "Duration of the sound, in seconds" + }, + { + "name": "date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the sound was created" + }, + { + "name": "title", + "type": "string", + "description": "Title of the notification sound" + }, + { + "name": "data", + "type": "string", + "description": "Arbitrary data, defined while the sound was uploaded" + }, + { + "name": "sound", + "type": "file", + "description": "File containing the sound" + } + ], + "description": "Describes a notification sound in MP3 format", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "notificationSounds", + "methods": [ + { + "name": "notification_sounds", + "type": "vector", + "description": "A list of notification sounds" + } + ], + "description": "Contains a list of notification sounds", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "notification", "methods": [ @@ -13406,7 +17145,7 @@ { "name": "is_silent", "type": "Bool", - "description": "True, if the notification was initially silent" + "description": "True, if the notification was explicitly sent without sound" }, { "name": "type", @@ -13663,7 +17402,7 @@ "methods": [ { "name": "user_ids", - "type": "vector", + "type": "vector", "description": "The user identifiers, total number of users in all rules must not exceed 1000" } ], @@ -13711,7 +17450,7 @@ "methods": [ { "name": "user_ids", - "type": "vector", + "type": "vector", "description": "The user identifiers, total number of users in all rules must not exceed 1000" } ], @@ -13832,13 +17571,22 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "userPrivacySettingAllowPrivateVoiceAndVideoNoteMessages", + "methods": null, + "description": "A privacy setting for managing whether the user can receive voice and video messages in private chats", + "inheritance": "UserPrivacySetting", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "accountTtl", "methods": [ { "name": "days", "type": "int32", - "description": "Number of days of inactivity before the account will be flagged for deletion; should range from 30-366 days" + "description": "Number of days of inactivity before the account will be flagged for deletion; 30-366 days" } ], "description": "Contains information about the period of inactivity after which the current user's account will automatically be deleted", @@ -13847,6 +17595,168 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "SessionType", + "methods": null, + "description": "Represents the type of a session", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeAndroid", + "methods": null, + "description": "The session is running on an Android device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeApple", + "methods": null, + "description": "The session is running on a generic Apple device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeBrave", + "methods": null, + "description": "The session is running on the Brave browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeChrome", + "methods": null, + "description": "The session is running on the Chrome browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeEdge", + "methods": null, + "description": "The session is running on the Edge browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeFirefox", + "methods": null, + "description": "The session is running on the Firefox browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeIpad", + "methods": null, + "description": "The session is running on an iPad device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeIphone", + "methods": null, + "description": "The session is running on an iPhone device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeLinux", + "methods": null, + "description": "The session is running on a Linux device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeMac", + "methods": null, + "description": "The session is running on a Mac device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeOpera", + "methods": null, + "description": "The session is running on the Opera browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeSafari", + "methods": null, + "description": "The session is running on the Safari browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeUbuntu", + "methods": null, + "description": "The session is running on an Ubuntu device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeUnknown", + "methods": null, + "description": "The session is running on an unknown type of device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeVivaldi", + "methods": null, + "description": "The session is running on the Vivaldi browser", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeWindows", + "methods": null, + "description": "The session is running on a Windows device", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "sessionTypeXbox", + "methods": null, + "description": "The session is running on an Xbox console", + "inheritance": "SessionType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "session", "methods": [ @@ -13863,7 +17773,22 @@ { "name": "is_password_pending", "type": "Bool", - "description": "True, if a password is needed to complete authorization of the session" + "description": "True, if a 2-step verification password is needed to complete authorization of the session" + }, + { + "name": "can_accept_secret_chats", + "type": "Bool", + "description": "True, if incoming secret chats can be accepted by the session" + }, + { + "name": "can_accept_calls", + "type": "Bool", + "description": "True, if incoming calls can be accepted by the session" + }, + { + "name": "type", + "type": "SessionType", + "description": "Session type based on the system and application version, which can be used to display a corresponding icon" }, { "name": "api_id", @@ -13926,7 +17851,7 @@ "description": "Region code from which the session was created, based on the IP address" } ], - "description": "Contains information about one session in a Telegram application used by the current user. Sessions should be shown to the user in the returned order", + "description": "Contains information about one session in a Telegram application used by the current user. Sessions must be shown to the user in the returned order", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -13939,6 +17864,11 @@ "name": "sessions", "type": "vector", "description": "List of sessions" + }, + { + "name": "inactive_session_ttl_days", + "type": "int32", + "description": "Number of days of inactivity before sessions will automatically be terminated; 1-366 days" } ], "description": "Contains a list of sessions", @@ -13962,7 +17892,7 @@ }, { "name": "bot_user_id", - "type": "int32", + "type": "int53", "description": "User identifier of a bot linked with the website" }, { @@ -13993,7 +17923,7 @@ { "name": "location", "type": "string", - "description": "Human-readable description of a country and a region, from which the user was logged in, based on the IP address" + "description": "Human-readable description of a country and a region from which the user was logged in, based on the IP address" } ], "description": "Contains information about one website the current user is logged in with Telegram", @@ -14080,17 +18010,635 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "chatReportReasonFake", + "methods": null, + "description": "The chat represents a fake account", + "inheritance": "ChatReportReason", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatReportReasonIllegalDrugs", + "methods": null, + "description": "The chat has illegal drugs related content", + "inheritance": "ChatReportReason", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "chatReportReasonPersonalDetails", + "methods": null, + "description": "The chat contains messages with personal details", + "inheritance": "ChatReportReason", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "chatReportReasonCustom", + "methods": null, + "description": "A custom reason provided by the user", + "inheritance": "ChatReportReason", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "TargetChat", + "methods": null, + "description": "Describes the target chat to be opened", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "targetChatCurrent", + "methods": null, + "description": "The currently opened chat needs to be kept", + "inheritance": "TargetChat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "targetChatChosen", + "methods": [ + { + "name": "allow_user_chats", + "type": "Bool", + "description": "True, if private chats with ordinary users are allowed" + }, + { + "name": "allow_bot_chats", + "type": "Bool", + "description": "True, if private chats with other bots are allowed" + }, + { + "name": "allow_group_chats", + "type": "Bool", + "description": "True, if basic group and supergroup chats are allowed" + }, + { + "name": "allow_channel_chats", + "type": "Bool", + "description": "True, if channel chats are allowed" + } + ], + "description": "The chat needs to be chosen by the user among chats of the specified types", + "inheritance": "TargetChat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "targetChatInternalLink", + "methods": [ + { + "name": "link", + "type": "InternalLinkType", + "description": "An internal link pointing to the chat" + } + ], + "description": "The chat needs to be open with the provided internal link", + "inheritance": "TargetChat", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "InternalLinkType", + "methods": null, + "description": "Describes an internal https://t.me or tg: link, which must be processed by the application in a special way", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeActiveSessions", + "methods": null, + "description": "The link is a link to the active sessions section of the application. Use getActiveSessions to handle the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeAttachmentMenuBot", + "methods": [ + { + "name": "target_chat", + "type": "TargetChat", + "description": "Target chat to be opened" + }, + { + "name": "bot_username", + "type": "string", + "description": "Username of the bot" + }, + { + "name": "url", + "type": "string", + "description": "URL to be passed to openWebApp" + } + ], + "description": "The link is a link to an attachment menu bot to be opened in the specified or a chosen chat. Process given target_chat to open the chat. Then call searchPublicChat with the given bot username, check that the user is a bot and can be added to attachment menu. Then use getAttachmentMenuBot to receive information about the bot. If the bot isn't added to attachment menu, then user needs to confirm adding the bot to attachment menu. If user confirms adding, then use toggleBotIsAddedToAttachmentMenu to add it. If the attachment menu bot can't be used in the opened chat, show an error to the user. If the bot is added to attachment menu and can be used in the chat, then use openWebApp with the given URL", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeAuthenticationCode", + "methods": [ + { + "name": "code", + "type": "string", + "description": "The authentication code" + } + ], + "description": "The link contains an authentication code. Call checkAuthenticationCode with the code if the current authorization state is authorizationStateWaitCode", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeBackground", + "methods": [ + { + "name": "background_name", + "type": "string", + "description": "Name of the background" + } + ], + "description": "The link is a link to a background. Call searchBackground with the given background name to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeBotStart", + "methods": [ + { + "name": "bot_username", + "type": "string", + "description": "Username of the bot" + }, + { + "name": "start_parameter", + "type": "string", + "description": "The parameter to be passed to sendBotStartMessage" + }, + { + "name": "autostart", + "type": "Bool", + "description": "True, if sendBotStartMessage must be called automatically without showing the START button" + } + ], + "description": "The link is a link to a chat with a Telegram bot. Call searchPublicChat with the given bot username, check that the user is a bot, show START button in the chat with the bot, and then call sendBotStartMessage with the given start parameter after the button is pressed", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeBotStartInGroup", + "methods": [ + { + "name": "bot_username", + "type": "string", + "description": "Username of the bot" + }, + { + "name": "start_parameter", + "type": "string", + "description": "The parameter to be passed to sendBotStartMessage" + }, + { + "name": "administrator_rights", + "type": "chatAdministratorRights", + "description": "Expected administrator rights for the bot; may be null" + } + ], + "description": "The link is a link to a Telegram bot, which is supposed to be added to a group chat. Call searchPublicChat with the given bot username, check that the user is a bot and can be added to groups, ask the current user to select a basic group or a supergroup chat to add the bot to, taking into account that bots can be added to a public supergroup only by administrators of the supergroup. If administrator rights are provided by the link, call getChatMember to receive the current bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights, combine received rights with the requested administrator rights, show confirmation box to the user, and call setChatMemberStatus with the chosen chat and confirmed administrator rights. Before call to setChatMemberStatus it may be required to upgrade the chosen basic group chat to a supergroup chat. Then if start_parameter isn't empty, call sendBotStartMessage with the given start parameter and the chosen chat, otherwise just send /start message with bot's username added to the chat.", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeBotAddToChannel", + "methods": [ + { + "name": "bot_username", + "type": "string", + "description": "Username of the bot" + }, + { + "name": "administrator_rights", + "type": "chatAdministratorRights", + "description": "Expected administrator rights for the bot" + } + ], + "description": "The link is a link to a Telegram bot, which is supposed to be added to a channel chat as an administrator. Call searchPublicChat with the given bot username and check that the user is a bot, ask the current user to select a channel chat to add the bot to as an administrator. Then call getChatMember to receive the current bot rights in the chat and if the bot already is an administrator, check that the current user can edit its administrator rights and combine received rights with the requested administrator rights. Then show confirmation box to the user, and call setChatMemberStatus with the chosen chat and confirmed rights", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeChangePhoneNumber", + "methods": null, + "description": "The link is a link to the change phone number section of the app", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeChatInvite", + "methods": [ + { + "name": "invite_link", + "type": "string", + "description": "Internal representation of the invite link" + } + ], + "description": "The link is a chat invite link. Call checkChatInviteLink with the given invite link to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeFilterSettings", + "methods": null, + "description": "The link is a link to the filter settings section of the app", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeGame", + "methods": [ + { + "name": "bot_username", + "type": "string", + "description": "Username of the bot that owns the game" + }, + { + "name": "game_short_name", + "type": "string", + "description": "Short name of the game" + } + ], + "description": "The link is a link to a game. Call searchPublicChat with the given bot username, check that the user is a bot, ask the current user to select a chat to send the game, and then call sendMessage with inputMessageGame", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeInstantView", + "methods": [ + { + "name": "url", + "type": "string", + "description": "URL to be passed to getWebPageInstantView" + } + ], + "description": "The link must be opened in an Instant View. Call getWebPageInstantView with the given URL to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeInvoice", + "methods": [ + { + "name": "invoice_name", + "type": "string", + "description": "Name of the invoice" + } + ], + "description": "The link is a link to an invoice. Call getPaymentForm with the given invoice name to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeLanguagePack", + "methods": [ + { + "name": "language_pack_id", + "type": "string", + "description": "Language pack identifier" + } + ], + "description": "The link is a link to a language pack. Call getLanguagePackInfo with the given language pack identifier to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeLanguageSettings", + "methods": null, + "description": "The link is a link to the language settings section of the app", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeMessage", + "methods": [ + { + "name": "url", + "type": "string", + "description": "URL to be passed to getMessageLinkInfo" + } + ], + "description": "The link is a link to a Telegram message. Call getMessageLinkInfo with the given URL to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeMessageDraft", "methods": [ { "name": "text", - "type": "string", - "description": "Report text" + "type": "formattedText", + "description": "Message draft text" + }, + { + "name": "contains_link", + "type": "Bool", + "description": "True, if the first line of the text contains a link. If true, the input field needs to be focused and the text after the link must be selected" } ], - "description": "A custom reason provided by the user", - "inheritance": "ChatReportReason", + "description": "The link contains a message draft text. A share screen needs to be shown to the user, then the chosen chat must be opened and the text is added to the input field", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypePassportDataRequest", + "methods": [ + { + "name": "bot_user_id", + "type": "int53", + "description": "User identifier of the service's bot" + }, + { + "name": "scope", + "type": "string", + "description": "Telegram Passport element types requested by the service" + }, + { + "name": "public_key", + "type": "string", + "description": "Service's public key" + }, + { + "name": "nonce", + "type": "string", + "description": "Unique request identifier provided by the service" + }, + { + "name": "callback_url", + "type": "string", + "description": "An HTTP URL to open once the request is finished or canceled with the parameter tg_passport=success or tg_passport=cancel respectively. If empty, then the link tgbot{bot_user_id}://passport/success or tgbot{bot_user_id}://passport/cancel needs to be opened instead" + } + ], + "description": "The link contains a request of Telegram passport data. Call getPassportAuthorizationForm with the given parameters to process the link if the link was received from outside of the application, otherwise ignore it", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypePhoneNumberConfirmation", + "methods": [ + { + "name": "hash", + "type": "string", + "description": "Hash value from the link" + }, + { + "name": "phone_number", + "type": "string", + "description": "Phone number value from the link" + } + ], + "description": "The link can be used to confirm ownership of a phone number to prevent account deletion. Call sendPhoneNumberConfirmationCode with the given hash and phone number to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypePremiumFeatures", + "methods": [ + { + "name": "referrer", + "type": "string", + "description": "Referrer specified in the link" + } + ], + "description": "The link is a link to the Premium features screen of the applcation from which the user can subscribe to Telegram Premium. Call getPremiumFeatures with the given referrer to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypePrivacyAndSecuritySettings", + "methods": null, + "description": "The link is a link to the privacy and security settings section of the app", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeProxy", + "methods": [ + { + "name": "server", + "type": "string", + "description": "Proxy server IP address" + }, + { + "name": "port", + "type": "int32", + "description": "Proxy server port" + }, + { + "name": "type", + "type": "ProxyType", + "description": "Type of the proxy" + } + ], + "description": "The link is a link to a proxy. Call addProxy with the given parameters to process the link and add the proxy", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypePublicChat", + "methods": [ + { + "name": "chat_username", + "type": "string", + "description": "Username of the chat" + } + ], + "description": "The link is a link to a chat by its username. Call searchPublicChat with the given chat username to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeQrCodeAuthentication", + "methods": null, + "description": "The link can be used to login the current user on another device, but it must be scanned from QR-code using in-app camera. An alert similar to \"This code can be used to allow someone to log in to your Telegram account. To confirm Telegram login, please go to Settings > Devices > Scan QR and scan the code\" needs to be shown", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeRestorePurchases", + "methods": null, + "description": "The link forces restore of App Store purchases when opened. For official iOS application only", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeSettings", + "methods": null, + "description": "The link is a link to application settings", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeStickerSet", + "methods": [ + { + "name": "sticker_set_name", + "type": "string", + "description": "Name of the sticker set" + } + ], + "description": "The link is a link to a sticker set. Call searchStickerSet with the given sticker set name to process the link and show the sticker set", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeTheme", + "methods": [ + { + "name": "theme_name", + "type": "string", + "description": "Name of the theme" + } + ], + "description": "The link is a link to a theme. TDLib has no theme support yet", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeThemeSettings", + "methods": null, + "description": "The link is a link to the theme settings section of the app", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeUnknownDeepLink", + "methods": [ + { + "name": "link", + "type": "string", + "description": "Link to be passed to getDeepLinkInfo" + } + ], + "description": "The link is an unknown tg: link. Call getDeepLinkInfo to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeUnsupportedProxy", + "methods": null, + "description": "The link is a link to an unsupported proxy. An alert can be shown to the user", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeUserPhoneNumber", + "methods": [ + { + "name": "phone_number", + "type": "string", + "description": "Phone number of the user" + } + ], + "description": "The link is a link to a user by its phone number. Call searchUserByPhoneNumber with the given phone number to process the link", + "inheritance": "InternalLinkType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "internalLinkTypeVideoChat", + "methods": [ + { + "name": "chat_username", + "type": "string", + "description": "Username of the chat with the video chat" + }, + { + "name": "invite_hash", + "type": "string", + "description": "If non-empty, invite hash to be used to join the video chat without being muted by administrators" + }, + { + "name": "is_live_stream", + "type": "Bool", + "description": "True, if the video chat is expected to be a live stream in a channel or a broadcast group" + } + ], + "description": "The link is a link to a video chat. Call searchPublicChat with the given chat username, and then joinGroupCall with the given invite hash to process the link", + "inheritance": "InternalLinkType", "return_type": "", "isFunction": false, "isSynchronous": false @@ -14133,6 +18681,11 @@ "type": "message", "description": "If found, the linked message; may be null" }, + { + "name": "media_timestamp", + "type": "int32", + "description": "Timestamp from which the video/audio/video note/voice note playing must start, in seconds; 0 if not specified. The media can be in the message content or in its web page preview" + }, { "name": "for_album", "type": "Bool", @@ -14210,6 +18763,15 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "fileTypeNotificationSound", + "methods": null, + "description": "The file is a notification sound", + "inheritance": "FileType", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "fileTypePhoto", "methods": null, @@ -14329,7 +18891,7 @@ { "name": "size", "type": "int53", - "description": "Total size of the files" + "description": "Total size of the files, in bytes" }, { "name": "count", @@ -14354,7 +18916,7 @@ { "name": "size", "type": "int53", - "description": "Total size of the files in the chat" + "description": "Total size of the files in the chat, in bytes" }, { "name": "count", @@ -14379,7 +18941,7 @@ { "name": "size", "type": "int53", - "description": "Total size of files" + "description": "Total size of files, in bytes" }, { "name": "count", @@ -14404,7 +18966,7 @@ { "name": "files_size", "type": "int53", - "description": "Approximate total size of files" + "description": "Approximate total size of files, in bytes" }, { "name": "file_count", @@ -14517,7 +19079,7 @@ { "name": "file_type", "type": "FileType", - "description": "Type of the file the data is part of" + "description": "Type of the file the data is part of; pass null if the data isn't related to files" }, { "name": "network_type", @@ -14602,22 +19164,22 @@ { "name": "max_photo_file_size", "type": "int32", - "description": "The maximum size of a photo file to be auto-downloaded" + "description": "The maximum size of a photo file to be auto-downloaded, in bytes" }, { "name": "max_video_file_size", - "type": "int32", - "description": "The maximum size of a video file to be auto-downloaded" + "type": "int53", + "description": "The maximum size of a video file to be auto-downloaded, in bytes" }, { "name": "max_other_file_size", - "type": "int32", - "description": "The maximum size of other file types to be auto-downloaded" + "type": "int53", + "description": "The maximum size of other file types to be auto-downloaded, in bytes" }, { "name": "video_upload_bitrate", "type": "int32", - "description": "The maximum suggested bitrate for uploaded videos" + "description": "The maximum suggested bitrate for uploaded videos, in kbit/s" }, { "name": "preload_large_videos", @@ -14660,7 +19222,7 @@ "description": "Preset with highest settings; supposed to be used by default when connected on Wi-Fi" } ], - "description": "Contains auto-download settings presets for the user", + "description": "Contains auto-download settings presets for the current user", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -14806,7 +19368,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user" } ], @@ -14837,7 +19399,7 @@ { "name": "info", "type": "chatInviteLinkInfo", - "description": "Chat invite link info" + "description": "Information about the chat invite link" } ], "description": "A chat invite link", @@ -14914,10 +19476,58 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "suggestedActionCheckPassword", + "methods": null, + "description": "Suggests the user to check whether they still remember their 2-step verification password", + "inheritance": "SuggestedAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "suggestedActionCheckPhoneNumber", "methods": null, - "description": "Suggests the user to check authorization phone number and change the phone number if it is inaccessible", + "description": "Suggests the user to check whether authorization phone number is correct and change the phone number if it is inaccessible", + "inheritance": "SuggestedAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "suggestedActionViewChecksHint", + "methods": null, + "description": "Suggests the user to view a hint about the meaning of one and two check marks on sent messages", + "inheritance": "SuggestedAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "suggestedActionConvertToBroadcastGroup", + "methods": [ + { + "name": "supergroup_id", + "type": "int53", + "description": "Supergroup identifier" + } + ], + "description": "Suggests the user to convert specified supergroup to a broadcast group", + "inheritance": "SuggestedAction", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "suggestedActionSetPassword", + "methods": [ + { + "name": "authorization_delay", + "type": "int32", + "description": "The number of days to pass between consecutive authorizations if the user declines to set password" + } + ], + "description": "Suggests the user to set a 2-step verification password to be able to log in again", "inheritance": "SuggestedAction", "return_type": "", "isFunction": false, @@ -14968,6 +19578,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "fileDownloadedPrefixSize", + "methods": [ + { + "name": "size", + "type": "int53", + "description": "The prefix size, in bytes" + } + ], + "description": "Contains size of downloaded prefix of a file", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "deepLinkInfo", "methods": [ @@ -14979,10 +19604,10 @@ { "name": "need_update_application", "type": "Bool", - "description": "True, if user should be asked to update the application" + "description": "True, if the user must be asked to update the application" } ], - "description": "Contains information about a tg:// deep link", + "description": "Contains information about a tg: deep link", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -14991,7 +19616,7 @@ { "name": "TextParseMode", "methods": null, - "description": "Describes the way the text should be parsed for TextEntities", + "description": "Describes the way the text needs to be parsed for TextEntities", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, @@ -15146,55 +19771,31 @@ "isSynchronous": false }, { - "name": "InputSticker", - "methods": null, - "description": "Describes a sticker that needs to be added to a sticker set", - "inheritance": "TLBaseClass", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "inputStickerStatic", + "name": "inputSticker", "methods": [ { "name": "sticker", "type": "InputFile", - "description": "PNG image with the sticker; must be up to 512 KB in size and fit in a 512x512 square" + "description": "File with the sticker; must fit in a 512x512 square. For WEBP stickers and masks the file must be in PNG format, which will be converted to WEBP server-side. Otherwise, the file must be local or uploaded within a week. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements" }, { "name": "emojis", "type": "string", "description": "Emojis corresponding to the sticker" }, + { + "name": "format", + "type": "StickerFormat", + "description": "Sticker format" + }, { "name": "mask_position", "type": "maskPosition", - "description": "For masks, position where the mask should be placed; may be null" + "description": "Position where the mask is placed; pass null if not specified" } ], - "description": "A static sticker in PNG format, which will be converted to WEBP server-side", - "inheritance": "InputSticker", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "inputStickerAnimated", - "methods": [ - { - "name": "sticker", - "type": "InputFile", - "description": "File with the animated sticker. Only local or uploaded within a week files are supported. See https://core.telegram.org/animated_stickers#technical-requirements for technical requirements" - }, - { - "name": "emojis", - "type": "string", - "description": "Emojis corresponding to the sticker" - } - ], - "description": "An animated sticker in TGS format", - "inheritance": "InputSticker", + "description": "A sticker to be added to a sticker set", + "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, "isSynchronous": false @@ -15220,12 +19821,12 @@ "isSynchronous": false }, { - "name": "statisticsValue", + "name": "statisticalValue", "methods": [ { "name": "value", "type": "double", - "description": "The value" + "description": "The current value" }, { "name": "previous_value", @@ -15238,23 +19839,23 @@ "description": "The growth rate of the value, as a percentage" } ], - "description": "A statistics value", + "description": "A value with information about its recent changes", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, "isSynchronous": false }, { - "name": "StatisticsGraph", + "name": "StatisticalGraph", "methods": null, - "description": "Describes a statistics graph", + "description": "Describes a statistical graph", "inheritance": "TLBaseClass", "return_type": "", "isFunction": false, "isSynchronous": false }, { - "name": "statisticsGraphData", + "name": "statisticalGraphData", "methods": [ { "name": "json_data", @@ -15268,13 +19869,13 @@ } ], "description": "A graph data", - "inheritance": "StatisticsGraph", + "inheritance": "StatisticalGraph", "return_type": "", "isFunction": false, "isSynchronous": false }, { - "name": "statisticsGraphAsync", + "name": "statisticalGraphAsync", "methods": [ { "name": "token", @@ -15282,14 +19883,14 @@ "description": "The token to use for data loading" } ], - "description": "The graph data to be asynchronously loaded through getStatisticsGraph", - "inheritance": "StatisticsGraph", + "description": "The graph data to be asynchronously loaded through getStatisticalGraph", + "inheritance": "StatisticalGraph", "return_type": "", "isFunction": false, "isSynchronous": false }, { - "name": "statisticsGraphError", + "name": "statisticalGraphError", "methods": [ { "name": "error_message", @@ -15298,7 +19899,7 @@ } ], "description": "An error message to be shown to the user instead of the graph", - "inheritance": "StatisticsGraph", + "inheritance": "StatisticalGraph", "return_type": "", "isFunction": false, "isSynchronous": false @@ -15333,7 +19934,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -15344,7 +19945,7 @@ { "name": "average_character_count", "type": "int32", - "description": "Average number of characters in sent messages" + "description": "Average number of characters in sent messages; 0 if unknown" } ], "description": "Contains statistics about messages sent by a user", @@ -15358,7 +19959,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Administrator user identifier" }, { @@ -15388,7 +19989,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -15422,62 +20023,62 @@ }, { "name": "member_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Number of members in the chat" }, { "name": "message_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Number of messages sent to the chat" }, { "name": "viewer_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Number of users who viewed messages in the chat" }, { "name": "sender_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Number of users who sent messages to the chat" }, { "name": "member_count_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of members in the chat" }, { "name": "join_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of members joined and left the chat" }, { "name": "join_by_source_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of new member joins per source" }, { "name": "language_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing distribution of active users per language" }, { "name": "message_content_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing distribution of sent messages by content type" }, { "name": "action_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of different actions in the chat" }, { "name": "day_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing distribution of message views per hour" }, { "name": "week_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing distribution of message views per day of week" }, { @@ -15512,17 +20113,17 @@ }, { "name": "member_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Number of members in the chat" }, { "name": "mean_view_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Mean number of times the recently sent messages was viewed" }, { "name": "mean_share_count", - "type": "statisticsValue", + "type": "statisticalValue", "description": "Mean number of times the recently sent messages was shared" }, { @@ -15532,47 +20133,47 @@ }, { "name": "member_count_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of members in the chat" }, { "name": "join_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of members joined and left the chat" }, { "name": "mute_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of members muted and unmuted the chat" }, { "name": "view_count_by_hour_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of message views in a given hour in the last two weeks" }, { "name": "view_count_by_source_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of message views per source" }, { "name": "join_by_source_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of new member joins per source" }, { "name": "language_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of users viewed chat messages per language" }, { "name": "message_interaction_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of chat message views and shares" }, { "name": "instant_view_interaction_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of views of associated with the chat instant views" }, { @@ -15592,7 +20193,7 @@ "methods": [ { "name": "message_interaction_graph", - "type": "StatisticsGraph", + "type": "StatisticalGraph", "description": "A graph containing number of message views and shares" } ], @@ -15602,6 +20203,170 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "point", + "methods": [ + { + "name": "x", + "type": "double", + "description": "The point's first coordinate" + }, + { + "name": "y", + "type": "double", + "description": "The point's second coordinate" + } + ], + "description": "A point on a Cartesian plane", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "VectorPathCommand", + "methods": null, + "description": "Represents a vector path command", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "vectorPathCommandLine", + "methods": [ + { + "name": "end_point", + "type": "point", + "description": "The end point of the straight line" + } + ], + "description": "A straight line to a given point", + "inheritance": "VectorPathCommand", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "vectorPathCommandCubicBezierCurve", + "methods": [ + { + "name": "start_control_point", + "type": "point", + "description": "The start control point of the curve" + }, + { + "name": "end_control_point", + "type": "point", + "description": "The end control point of the curve" + }, + { + "name": "end_point", + "type": "point", + "description": "The end point of the curve" + } + ], + "description": "A cubic Bézier curve to a given point", + "inheritance": "VectorPathCommand", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "BotCommandScope", + "methods": null, + "description": "Represents the scope to which bot commands are relevant", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeDefault", + "methods": null, + "description": "A scope covering all users", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeAllPrivateChats", + "methods": null, + "description": "A scope covering all private chats", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeAllGroupChats", + "methods": null, + "description": "A scope covering all group and supergroup chats", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeAllChatAdministrators", + "methods": null, + "description": "A scope covering all group and supergroup chat administrators", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeChat", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "A scope covering all members of a chat", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeChatAdministrators", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "A scope covering all administrators of a chat", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "botCommandScopeChatMember", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "user_id", + "type": "int53", + "description": "User identifier" + } + ], + "description": "A scope covering a member of a chat", + "inheritance": "BotCommandScope", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "Update", "methods": null, @@ -15667,7 +20432,7 @@ { "name": "message", "type": "message", - "description": "Information about the sent message. Usually only the message identifier, date, and content are changed, but almost all other fields can also change" + "description": "The sent message. Usually only the message identifier, date, and content are changed, but almost all other fields can also change" }, { "name": "old_message_id", @@ -15687,7 +20452,7 @@ { "name": "message", "type": "message", - "description": "Contains information about the message which failed to send" + "description": "The failed to send message" }, { "name": "old_message_id", @@ -15766,6 +20531,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateMessageIsPinned", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_id", + "type": "int53", + "description": "The message identifier" + }, + { + "name": "is_pinned", + "type": "Bool", + "description": "True, if the message is pinned" + } + ], + "description": "The message pinned state was changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateMessageInteractionInfo", "methods": [ @@ -15836,6 +20626,36 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateMessageUnreadReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + }, + { + "name": "unread_reactions", + "type": "vector", + "description": "The new list of unread reactions" + }, + { + "name": "unread_reaction_count", + "type": "int32", + "description": "The new number of messages with unread reactions left in the chat" + } + ], + "description": "The list of unread reactions added to a message was changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateMessageLiveLocationViewed", "methods": [ @@ -15976,86 +20796,6 @@ "isFunction": false, "isSynchronous": false }, - { - "name": "updateChatIsMarkedAsUnread", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "is_marked_as_unread", - "type": "Bool", - "description": "New value of is_marked_as_unread" - } - ], - "description": "A chat was marked as unread or was read", - "inheritance": "Update", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "updateChatIsBlocked", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "is_blocked", - "type": "Bool", - "description": "New value of is_blocked" - } - ], - "description": "A chat was blocked or unblocked", - "inheritance": "Update", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "updateChatHasScheduledMessages", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "has_scheduled_messages", - "type": "Bool", - "description": "New value of has_scheduled_messages" - } - ], - "description": "A chat's has_scheduled_messages field has changed", - "inheritance": "Update", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "updateChatDefaultDisableNotification", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "default_disable_notification", - "type": "Bool", - "description": "The new default_disable_notification value" - } - ], - "description": "The value of the default disable_notification parameter, used when a message is sent to the chat, was changed", - "inheritance": "Update", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, { "name": "updateChatReadInbox", "methods": [ @@ -16075,7 +20815,7 @@ "description": "The number of unread messages left in the chat" } ], - "description": "Incoming messages were read or number of unread messages has been changed", + "description": "Incoming messages were read or the number of unread messages has been changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16102,7 +20842,7 @@ "isSynchronous": false }, { - "name": "updateChatUnreadMentionCount", + "name": "updateChatActionBar", "methods": [ { "name": "chat_id", @@ -16110,12 +20850,97 @@ "description": "Chat identifier" }, { - "name": "unread_mention_count", - "type": "int32", - "description": "The number of unread mention messages left in the chat" + "name": "action_bar", + "type": "ChatActionBar", + "description": "The new value of the action bar; may be null" } ], - "description": "The chat unread_mention_count has changed", + "description": "The chat action bar was changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatAvailableReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "available_reactions", + "type": "ChatAvailableReactions", + "description": "The new reactions, available in the chat" + } + ], + "description": "The chat available reactions were changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatDraftMessage", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "draft_message", + "type": "draftMessage", + "description": "The new draft message; may be null" + }, + { + "name": "positions", + "type": "vector", + "description": "The new chat positions in the chat lists" + } + ], + "description": "A chat draft has changed. Be aware that the update may come in the currently opened chat but with old content of the draft. If the user has changed the content of the draft, this update mustn't be applied", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatMessageSender", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_sender_id", + "type": "MessageSender", + "description": "New value of message_sender_id; may be null if the user can't change message sender" + } + ], + "description": "The message sender that is selected to send messages in a chat has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatMessageTtl", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_ttl", + "type": "int32", + "description": "New value of message_ttl" + } + ], + "description": "The message Time To Live setting for a chat was changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16142,27 +20967,7 @@ "isSynchronous": false }, { - "name": "updateScopeNotificationSettings", - "methods": [ - { - "name": "scope", - "type": "NotificationSettingsScope", - "description": "Types of chats for which notification settings were updated" - }, - { - "name": "notification_settings", - "type": "scopeNotificationSettings", - "description": "The new notification settings" - } - ], - "description": "Notification settings for some type of chats were updated", - "inheritance": "Update", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "updateChatActionBar", + "name": "updateChatPendingJoinRequests", "methods": [ { "name": "chat_id", @@ -16170,32 +20975,12 @@ "description": "Chat identifier" }, { - "name": "action_bar", - "type": "ChatActionBar", - "description": "The new value of the action bar; may be null" + "name": "pending_join_requests", + "type": "chatJoinRequestsInfo", + "description": "The new data about pending join requests; may be null" } ], - "description": "The chat action bar was changed", - "inheritance": "Update", - "return_type": "", - "isFunction": false, - "isSynchronous": false - }, - { - "name": "updateChatPinnedMessage", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "pinned_message_id", - "type": "int53", - "description": "The new identifier of the pinned message; 0 if there is no pinned message in the chat" - } - ], - "description": "The chat pinned message was changed", + "description": "The chat pending join requests were changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16222,7 +21007,7 @@ "isSynchronous": false }, { - "name": "updateChatDraftMessage", + "name": "updateChatTheme", "methods": [ { "name": "chat_id", @@ -16230,17 +21015,172 @@ "description": "Chat identifier" }, { - "name": "draft_message", - "type": "draftMessage", - "description": "The new draft message; may be null" - }, - { - "name": "positions", - "type": "vector", - "description": "The new chat positions in the chat lists" + "name": "theme_name", + "type": "string", + "description": "The new name of the chat theme; may be empty if theme was reset to default" } ], - "description": "A chat draft has changed. Be aware that the update may come in the currently opened chat but with old content of the draft. If the user has changed the content of the draft, this update shouldn't be applied", + "description": "The chat theme was changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatUnreadMentionCount", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "unread_mention_count", + "type": "int32", + "description": "The number of unread mention messages left in the chat" + } + ], + "description": "The chat unread_mention_count has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatUnreadReactionCount", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "unread_reaction_count", + "type": "int32", + "description": "The number of messages with unread reactions left in the chat" + } + ], + "description": "The chat unread_reaction_count has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatVideoChat", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "video_chat", + "type": "videoChat", + "description": "New value of video_chat" + } + ], + "description": "A chat video chat state has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatDefaultDisableNotification", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "default_disable_notification", + "type": "Bool", + "description": "The new default_disable_notification value" + } + ], + "description": "The value of the default disable_notification parameter, used when a message is sent to the chat, was changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatHasProtectedContent", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "has_protected_content", + "type": "Bool", + "description": "New value of has_protected_content" + } + ], + "description": "A chat content was allowed or restricted for saving", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatHasScheduledMessages", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "has_scheduled_messages", + "type": "Bool", + "description": "New value of has_scheduled_messages" + } + ], + "description": "A chat's has_scheduled_messages field has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatIsBlocked", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "is_blocked", + "type": "Bool", + "description": "New value of is_blocked" + } + ], + "description": "A chat was blocked or unblocked", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateChatIsMarkedAsUnread", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "is_marked_as_unread", + "type": "Bool", + "description": "New value of is_marked_as_unread" + } + ], + "description": "A chat was marked as unread or was read", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16253,6 +21193,11 @@ "name": "chat_filters", "type": "vector", "description": "The new list of chat filters" + }, + { + "name": "main_chat_list_position", + "type": "int32", + "description": "Position of the main chat list among chat filters, 0-based" } ], "description": "The list of chat filters or a chat filter has changed", @@ -16275,7 +21220,27 @@ "description": "New number of online members in the chat, or 0 if unknown" } ], - "description": "The number of online group members has changed. This update with non-zero count is sent only for currently opened chats. There is no guarantee that it will be sent just after the count has changed", + "description": "The number of online group members has changed. This update with non-zero number of online group members is sent only for currently opened chats. There is no guarantee that it will be sent just after the number of online users has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateScopeNotificationSettings", + "methods": [ + { + "name": "scope", + "type": "NotificationSettingsScope", + "description": "Types of chats for which notification settings were updated" + }, + { + "name": "notification_settings", + "type": "scopeNotificationSettings", + "description": "The new notification settings" + } + ], + "description": "Notification settings for some type of chats were updated", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16325,9 +21290,9 @@ "description": "Chat identifier, which notification settings must be applied to the added notifications" }, { - "name": "is_silent", - "type": "Bool", - "description": "True, if the notifications should be shown without sound" + "name": "notification_sound_id", + "type": "int64", + "description": "Identifier of the notification sound to be played; 0 if sound is disabled" }, { "name": "total_count", @@ -16417,7 +21382,7 @@ "isSynchronous": false }, { - "name": "updateUserChatAction", + "name": "updateChatAction", "methods": [ { "name": "chat_id", @@ -16430,17 +21395,17 @@ "description": "If not 0, a message thread identifier in which the action was performed" }, { - "name": "user_id", - "type": "int32", - "description": "Identifier of a user performing an action" + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of a message sender performing the action" }, { "name": "action", "type": "ChatAction", - "description": "The action description" + "description": "The action" } ], - "description": "User activity in the chat has changed", + "description": "A message sender activity in the chat has changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16451,7 +21416,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -16531,7 +21496,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -16540,7 +21505,7 @@ "description": "New full information about the user" } ], - "description": "Some data from userFullInfo has been changed", + "description": "Some data in userFullInfo has been changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16551,7 +21516,7 @@ "methods": [ { "name": "basic_group_id", - "type": "int32", + "type": "int53", "description": "Identifier of a basic group" }, { @@ -16560,7 +21525,7 @@ "description": "New full information about the group" } ], - "description": "Some data from basicGroupFullInfo has been changed", + "description": "Some data in basicGroupFullInfo has been changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16571,7 +21536,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the supergroup or channel" }, { @@ -16580,7 +21545,7 @@ "description": "New full information about the supergroup" } ], - "description": "Some data from supergroupFullInfo has been changed", + "description": "Some data in supergroupFullInfo has been changed", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16592,7 +21557,7 @@ { "name": "type", "type": "string", - "description": "Notification type. If type begins with \"AUTH_KEY_DROP_\", then two buttons \"Cancel\" and \"Log out\" should be shown under notification; if user presses the second, all local data should be destroyed using Destroy method" + "description": "Notification type. If type begins with \"AUTH_KEY_DROP_\", then two buttons \"Cancel\" and \"Log out\" must be shown under notification; if user presses the second, all local data must be destroyed using Destroy method" }, { "name": "content", @@ -16600,7 +21565,7 @@ "description": "Notification content" } ], - "description": "Service notification from the server. Upon receiving this the application must show a popup with the content of the notification", + "description": "A service notification from the server was received. Upon receiving this the application must show a popup with the content of the notification", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16637,12 +21602,12 @@ { "name": "destination_path", "type": "string", - "description": "The path to a file that should be created and where the new file should be generated" + "description": "The path to a file that must be created and where the new file is generated" }, { "name": "conversion", "type": "string", - "description": "String specifying the conversion applied to the original file. If conversion is \"#url#\" than original_path contains an HTTP/HTTPS URL of a file, which should be downloaded by the application" + "description": "String specifying the conversion applied to the original file. If conversion is \"#url#\" than original_path contains an HTTP/HTTPS URL of a file, which must be downloaded by the application" } ], "description": "The file generation process needs to be started by the application", @@ -16666,6 +21631,101 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateFileDownloads", + "methods": [ + { + "name": "total_size", + "type": "int53", + "description": "Total size of files in the file download list, in bytes" + }, + { + "name": "total_count", + "type": "int32", + "description": "Total number of files in the file download list" + }, + { + "name": "downloaded_size", + "type": "int53", + "description": "Total downloaded size of files in the file download list, in bytes" + } + ], + "description": "The state of the file download list has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateFileAddedToDownloads", + "methods": [ + { + "name": "file_download", + "type": "fileDownload", + "description": "The added file download" + }, + { + "name": "counts", + "type": "downloadedFileCounts", + "description": "New number of being downloaded and recently downloaded files found" + } + ], + "description": "A file was added to the file download list. This update is sent only after file download list is loaded for the first time", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateFileDownload", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "File identifier" + }, + { + "name": "complete_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the file downloading was completed; 0 if the file downloading isn't completed" + }, + { + "name": "is_paused", + "type": "Bool", + "description": "True, if downloading of the file is paused" + }, + { + "name": "counts", + "type": "downloadedFileCounts", + "description": "New number of being downloaded and recently downloaded files found" + } + ], + "description": "A file download was changed. This update is sent only after file download list is loaded for the first time", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateFileRemovedFromDownloads", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "File identifier" + }, + { + "name": "counts", + "type": "downloadedFileCounts", + "description": "New number of being downloaded and recently downloaded files found" + } + ], + "description": "A file was removed from the file download list. This update is sent only after file download list is loaded for the first time", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateCall", "methods": [ @@ -16681,6 +21741,41 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateGroupCall", + "methods": [ + { + "name": "group_call", + "type": "groupCall", + "description": "New data about a group call" + } + ], + "description": "Information about a group call was updated", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateGroupCallParticipant", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Identifier of group call" + }, + { + "name": "participant", + "type": "groupCallParticipant", + "description": "New data about a participant" + } + ], + "description": "Information about a group call participant was changed. The updates are sent only after the group call is received through getGroupCall and only if the call is joined or being joined", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateNewCallSignalingData", "methods": [ @@ -16825,9 +21920,9 @@ "name": "updateInstalledStickerSets", "methods": [ { - "name": "is_masks", - "type": "Bool", - "description": "True, if the list of installed mask sticker sets was updated" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the affected stickers" }, { "name": "sticker_set_ids", @@ -16844,9 +21939,14 @@ { "name": "updateTrendingStickerSets", "methods": [ + { + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the affected stickers" + }, { "name": "sticker_sets", - "type": "stickerSets", + "type": "trendingStickerSets", "description": "The prefix of the list of trending sticker sets with the newest trending sticker sets" } ], @@ -16906,6 +22006,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateSavedNotificationSounds", + "methods": [ + { + "name": "notification_sound_ids", + "type": "vector", + "description": "The new list of identifiers of saved notification sounds" + } + ], + "description": "The list of saved notifications sounds was updated. This update may not be sent until information about a notification sound was requested for the first time", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateSelectedBackground", "methods": [ @@ -16926,6 +22041,21 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateChatThemes", + "methods": [ + { + "name": "chat_themes", + "type": "vector", + "description": "The new list of chat themes" + } + ], + "description": "The list of available chat themes has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateLanguagePackStrings", "methods": [ @@ -16960,7 +22090,7 @@ "description": "The new connection state" } ], - "description": "The connection state has changed. This update must be used only to show the user a human-readable description of the connection state", + "description": "The connection state has changed. This update must be used only to show a human-readable description of the connection state", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -16980,7 +22110,7 @@ "description": "The new terms of service" } ], - "description": "New terms of service must be accepted by the user. If the terms of service are declined, then the deleteAccount method should be called with the reason \"Decline ToS update\"", + "description": "New terms of service must be accepted by the user. If the terms of service are declined, then the deleteAccount method must be called with the reason \"Decline ToS update\"", "inheritance": "Update", "return_type": "", "isFunction": false, @@ -17001,6 +22131,66 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateAttachmentMenuBots", + "methods": [ + { + "name": "bots", + "type": "vector", + "description": "The new list of bots added to attachment menu. The bots must not be shown on scheduled messages screen" + } + ], + "description": "The list of bots added to attachment menu has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateWebAppMessageSent", + "methods": [ + { + "name": "web_app_launch_id", + "type": "int64", + "description": "Identifier of Web App launch" + } + ], + "description": "A message was sent by an opened Web App, so the Web App needs to be closed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateActiveEmojiReactions", + "methods": [ + { + "name": "emojis", + "type": "vector", + "description": "The new list of active emoji reactions" + } + ], + "description": "The list of active emoji reactions has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateDefaultReactionType", + "methods": [ + { + "name": "reaction_type", + "type": "ReactionType", + "description": "The new type of the default reaction" + } + ], + "description": "The type of default reaction has changed", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateDiceEmojis", "methods": [ @@ -17016,6 +22206,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateAnimatedEmojiMessageClicked", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + }, + { + "name": "sticker", + "type": "sticker", + "description": "The animated sticker to be played" + } + ], + "description": "Some animated emoji message was clicked and a big animated sticker must be played if the message is visible on the screen. chatActionWatchingAnimations with the text of the message needs to be sent if the sticker is played", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updateAnimationSearchParameters", "methods": [ @@ -17066,7 +22281,7 @@ }, { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user who sent the query" }, { @@ -17074,6 +22289,11 @@ "type": "location", "description": "User location; may be null" }, + { + "name": "chat_type", + "type": "ChatType", + "description": "The type of the chat from which the query originated; may be null if unknown" + }, { "name": "query", "type": "string", @@ -17096,7 +22316,7 @@ "methods": [ { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user who sent the query" }, { @@ -17136,7 +22356,7 @@ }, { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user who sent the query" }, { @@ -17147,7 +22367,7 @@ { "name": "message_id", "type": "int53", - "description": "Identifier of the message, from which the query originated" + "description": "Identifier of the message from which the query originated" }, { "name": "chat_instance", @@ -17176,13 +22396,13 @@ }, { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user who sent the query" }, { "name": "inline_message_id", "type": "string", - "description": "Identifier of the inline message, from which the query originated" + "description": "Identifier of the inline message from which the query originated" }, { "name": "chat_instance", @@ -17211,7 +22431,7 @@ }, { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user who sent the query" }, { @@ -17241,7 +22461,7 @@ }, { "name": "sender_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user who sent the query" }, { @@ -17252,7 +22472,7 @@ { "name": "total_amount", "type": "int53", - "description": "Total price for the product, in the minimal quantity of the currency" + "description": "Total price for the product, in the smallest units of the currency" }, { "name": "invoice_payload", @@ -17341,7 +22561,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "The user, who changed the answer to the poll" }, { @@ -17356,6 +22576,71 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "updateChatMember", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "actor_user_id", + "type": "int53", + "description": "Identifier of the user, changing the rights" + }, + { + "name": "date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the user rights was changed" + }, + { + "name": "invite_link", + "type": "chatInviteLink", + "description": "If user has joined the chat using an invite link, the invite link; may be null" + }, + { + "name": "old_chat_member", + "type": "chatMember", + "description": "Previous chat member" + }, + { + "name": "new_chat_member", + "type": "chatMember", + "description": "New chat member" + } + ], + "description": "User rights changed in a chat; for bots only", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, + { + "name": "updateNewChatJoinRequest", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "request", + "type": "chatJoinRequest", + "description": "Join request" + }, + { + "name": "invite_link", + "type": "chatInviteLink", + "description": "The invite link, which was used to send join request; may be null" + } + ], + "description": "A user sent a join request to a chat; for bots only", + "inheritance": "Update", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "updates", "methods": [ @@ -17400,7 +22685,7 @@ { "name": "max_file_size", "type": "int53", - "description": "The maximum size of the file to where the internal TDLib log is written before the file will be auto-rotated" + "description": "The maximum size of the file to where the internal TDLib log is written before the file will automatically be rotated, in bytes" }, { "name": "redirect_stderr", @@ -17453,6 +22738,31 @@ "isFunction": false, "isSynchronous": false }, + { + "name": "userSupportInfo", + "methods": [ + { + "name": "message", + "type": "formattedText", + "description": "Information message" + }, + { + "name": "author", + "type": "string", + "description": "Information author" + }, + { + "name": "date", + "type": "int32", + "description": "Information change date" + } + ], + "description": "Contains custom information about the user", + "inheritance": "TLBaseClass", + "return_type": "", + "isFunction": false, + "isSynchronous": false + }, { "name": "testInt", "methods": [ @@ -17571,9 +22881,84 @@ "name": "setTdlibParameters", "methods": [ { - "name": "parameters", - "type": "tdlibParameters", - "description": "Parameters" + "name": "use_test_dc", + "type": "Bool", + "description": "Pass true to use Telegram test environment instead of the production environment" + }, + { + "name": "database_directory", + "type": "string", + "description": "The path to the directory for the persistent database; if empty, the current working directory will be used" + }, + { + "name": "files_directory", + "type": "string", + "description": "The path to the directory for storing files; if empty, database_directory will be used" + }, + { + "name": "database_encryption_key", + "type": "bytes", + "description": "Encryption key for the database" + }, + { + "name": "use_file_database", + "type": "Bool", + "description": "Pass true to keep information about downloaded and uploaded files between application restarts" + }, + { + "name": "use_chat_info_database", + "type": "Bool", + "description": "Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies use_file_database" + }, + { + "name": "use_message_database", + "type": "Bool", + "description": "Pass true to keep cache of chats and messages between restarts. Implies use_chat_info_database" + }, + { + "name": "use_secret_chats", + "type": "Bool", + "description": "Pass true to enable support for secret chats" + }, + { + "name": "api_id", + "type": "int32", + "description": "Application identifier for Telegram API access, which can be obtained at https://my.telegram.org" + }, + { + "name": "api_hash", + "type": "string", + "description": "Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org" + }, + { + "name": "system_language_code", + "type": "string", + "description": "IETF language tag of the user's operating system language; must be non-empty" + }, + { + "name": "device_model", + "type": "string", + "description": "Model of the device the application is being run on; must be non-empty" + }, + { + "name": "system_version", + "type": "string", + "description": "Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib" + }, + { + "name": "application_version", + "type": "string", + "description": "Application version; must be non-empty" + }, + { + "name": "enable_storage_optimizer", + "type": "Bool", + "description": "Pass true to automatically delete old files in background" + }, + { + "name": "ignore_file_names", + "type": "Bool", + "description": "Pass true to ignore original file names for downloaded files. Otherwise, downloaded files are saved under names as close as possible to the original name" } ], "description": "Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters", @@ -17582,21 +22967,6 @@ "isFunction": true, "isSynchronous": false }, - { - "name": "checkDatabaseEncryptionKey", - "methods": [ - { - "name": "encryption_key", - "type": "bytes", - "description": "Encryption key to check or set up" - } - ], - "description": "Checks the database encryption key for correctness. Works only when the current authorization state is authorizationStateWaitEncryptionKey", - "inheritance": "TLBaseClass", - "return_type": "ok", - "isFunction": true, - "isSynchronous": false - }, { "name": "setAuthenticationPhoneNumber", "methods": [ @@ -17608,7 +22978,7 @@ { "name": "settings", "type": "phoneNumberAuthenticationSettings", - "description": "Settings for the authentication of the user's phone number" + "description": "Settings for the authentication of the user's phone number; pass null to use default settings" } ], "description": "Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword", @@ -17617,10 +22987,40 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "setAuthenticationEmailAddress", + "methods": [ + { + "name": "email_address", + "type": "string", + "description": "The email address of the user" + } + ], + "description": "Sets the email address of the user and sends an authentication code to the email address. Works only when the current authorization state is authorizationStateWaitEmailAddress", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "resendAuthenticationCode", "methods": null, - "description": "Re-sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode and the next_code_type of the result is not null", + "description": "Resends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitCode, the next_code_type of the result is not null and the server-specified timeout has passed, or when the current authorization state is authorizationStateWaitEmailCode", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "checkAuthenticationEmailCode", + "methods": [ + { + "name": "code", + "type": "EmailAddressAuthentication", + "description": "Email address authentication to check" + } + ], + "description": "Checks the authentication of a email address. Works only when the current authorization state is authorizationStateWaitEmailCode", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -17632,7 +23032,7 @@ { "name": "code", "type": "string", - "description": "The verification code received via SMS, Telegram message, phone call, or flash call" + "description": "Authentication code to check" } ], "description": "Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode", @@ -17646,7 +23046,7 @@ "methods": [ { "name": "other_user_ids", - "type": "vector", + "type": "vector", "description": "List of user identifiers of other users currently using the application" } ], @@ -17682,10 +23082,10 @@ { "name": "password", "type": "string", - "description": "The password to check" + "description": "The 2-step verification password to check" } ], - "description": "Checks the authentication password for correctness. Works only when the current authorization state is authorizationStateWaitPassword", + "description": "Checks the 2-step verification password for correctness. Works only when the current authorization state is authorizationStateWaitPassword", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -17694,7 +23094,22 @@ { "name": "requestAuthenticationPasswordRecovery", "methods": null, - "description": "Requests to send a password recovery code to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword", + "description": "Requests to send a 2-step verification password recovery code to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "checkAuthenticationPasswordRecoveryCode", + "methods": [ + { + "name": "recovery_code", + "type": "string", + "description": "Recovery code to check" + } + ], + "description": "Checks whether a 2-step verification password recovery code sent to an email address is valid. Works only when the current authorization state is authorizationStateWaitPassword", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -17707,9 +23122,19 @@ "name": "recovery_code", "type": "string", "description": "Recovery code to check" + }, + { + "name": "new_password", + "type": "string", + "description": "New 2-step verification password of the user; may be empty to remove the password" + }, + { + "name": "new_hint", + "type": "string", + "description": "New password hint; may be empty" } ], - "description": "Recovers the password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword", + "description": "Recovers the 2-step verification password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -17811,12 +23236,12 @@ { "name": "old_password", "type": "string", - "description": "Previous password of the user" + "description": "Previous 2-step verification password of the user" }, { "name": "new_password", "type": "string", - "description": "New password of the user; may be empty to remove the password" + "description": "New 2-step verification password of the user; may be empty to remove the password" }, { "name": "new_hint", @@ -17826,7 +23251,7 @@ { "name": "set_recovery_email_address", "type": "Bool", - "description": "Pass true if the recovery email address should be changed" + "description": "Pass true to change also the recovery email address" }, { "name": "new_recovery_email_address", @@ -17834,19 +23259,58 @@ "description": "New recovery email address; may be empty" } ], - "description": "Changes the password for the user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed", + "description": "Changes the 2-step verification password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed", "inheritance": "TLBaseClass", "return_type": "passwordState", "isFunction": true, "isSynchronous": false }, + { + "name": "setLoginEmailAddress", + "methods": [ + { + "name": "new_login_email_address", + "type": "string", + "description": "New login email address" + } + ], + "description": "Changes the login email address of the user. The change will not be applied until the new login email address is confirmed with `checkLoginEmailAddressCode`. To use Apple ID/Google ID instead of a email address, call `checkLoginEmailAddressCode` directly", + "inheritance": "TLBaseClass", + "return_type": "emailAddressAuthenticationCodeInfo", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "resendLoginEmailAddressCode", + "methods": null, + "description": "Resends the login email address verification code", + "inheritance": "TLBaseClass", + "return_type": "emailAddressAuthenticationCodeInfo", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "checkLoginEmailAddressCode", + "methods": [ + { + "name": "code", + "type": "EmailAddressAuthentication", + "description": "Email address authentication to check" + } + ], + "description": "Checks the login email address authentication", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "getRecoveryEmailAddress", "methods": [ { "name": "password", "type": "string", - "description": "The password for the current user" + "description": "The 2-step verification password for the current user" } ], "description": "Returns a 2-step verification recovery email address that was previously set up. This method can be used to verify a password provided by the user", @@ -17861,7 +23325,7 @@ { "name": "password", "type": "string", - "description": "Password of the current user" + "description": "The 2-step verification password of the current user" }, { "name": "new_recovery_email_address", @@ -17881,7 +23345,7 @@ { "name": "code", "type": "string", - "description": "Verification code" + "description": "Verification code to check" } ], "description": "Checks the 2-step verification recovery email address verification code", @@ -17902,12 +23366,27 @@ { "name": "requestPasswordRecovery", "methods": null, - "description": "Requests to send a password recovery code to an email address that was previously set up", + "description": "Requests to send a 2-step verification password recovery code to an email address that was previously set up", "inheritance": "TLBaseClass", "return_type": "emailAddressAuthenticationCodeInfo", "isFunction": true, "isSynchronous": false }, + { + "name": "checkPasswordRecoveryCode", + "methods": [ + { + "name": "recovery_code", + "type": "string", + "description": "Recovery code to check" + } + ], + "description": "Checks whether a 2-step verification password recovery code sent to an email address is valid", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "recoverPassword", "methods": [ @@ -17915,26 +23394,54 @@ "name": "recovery_code", "type": "string", "description": "Recovery code to check" + }, + { + "name": "new_password", + "type": "string", + "description": "New 2-step verification password of the user; may be empty to remove the password" + }, + { + "name": "new_hint", + "type": "string", + "description": "New password hint; may be empty" } ], - "description": "Recovers the password using a recovery code sent to an email address that was previously set up", + "description": "Recovers the 2-step verification password using a recovery code sent to an email address that was previously set up", "inheritance": "TLBaseClass", "return_type": "passwordState", "isFunction": true, "isSynchronous": false }, + { + "name": "resetPassword", + "methods": null, + "description": "Removes 2-step verification password without previous password and access to recovery email address. The password can't be reset immediately and the request needs to be repeated after the specified time", + "inheritance": "TLBaseClass", + "return_type": "ResetPasswordResult", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "cancelPasswordReset", + "methods": null, + "description": "Cancels reset of 2-step verification password. The method can be called if passwordState.pending_reset_date > 0", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "createTemporaryPassword", "methods": [ { "name": "password", "type": "string", - "description": "Persistent user password" + "description": "The 2-step verification password of the current user" }, { "name": "valid_for", "type": "int32", - "description": "Time during which the temporary password will be valid, in seconds; should be between 60 and 86400" + "description": "Time during which the temporary password will be valid, in seconds; must be between 60 and 86400" } ], "description": "Creates a new temporary password for processing payments", @@ -17966,7 +23473,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" } ], @@ -17981,7 +23488,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" } ], @@ -17996,7 +23503,7 @@ "methods": [ { "name": "basic_group_id", - "type": "int32", + "type": "int53", "description": "Basic group identifier" } ], @@ -18011,7 +23518,7 @@ "methods": [ { "name": "basic_group_id", - "type": "int32", + "type": "int53", "description": "Basic group identifier" } ], @@ -18026,7 +23533,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Supergroup or channel identifier" } ], @@ -18041,7 +23548,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Supergroup or channel identifier" } ], @@ -18115,7 +23622,7 @@ "description": "Identifier of the message to get" } ], - "description": "Returns information about a message, if it is available locally without sending network request. This is an offline request", + "description": "Returns information about a message, if it is available without sending network request. This is an offline request", "inheritance": "TLBaseClass", "return_type": "message", "isFunction": true, @@ -18132,7 +23639,7 @@ { "name": "message_id", "type": "int53", - "description": "Identifier of the message reply to which to get" + "description": "Identifier of the reply message" } ], "description": "Returns information about a message that is replied by a given message. Also returns the pinned message, the game message, and the invoice message for messages of the types messagePinMessage, messageGameScore, and messagePaymentSuccessful respectively", @@ -18150,7 +23657,32 @@ "description": "Identifier of the chat the message belongs to" } ], - "description": "Returns information about a pinned chat message", + "description": "Returns information about a newest pinned message in the chat", + "inheritance": "TLBaseClass", + "return_type": "message", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getCallbackQueryMessage", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat the message belongs to" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + }, + { + "name": "callback_query_id", + "type": "int64", + "description": "Identifier of the callback query" + } + ], + "description": "Returns information about a message with the callback button that originated a callback query; for bots only", "inheritance": "TLBaseClass", "return_type": "message", "isFunction": true, @@ -18196,6 +23728,26 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getMessageViewers", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + } + ], + "description": "Returns viewers of a recent outgoing message in a basic group or a supergroup chat. For video notes and voice notes only users, opened content of the message, are returned. The method can be called if message.can_get_viewers == true", + "inheritance": "TLBaseClass", + "return_type": "users", + "isFunction": true, + "isSynchronous": false + }, { "name": "getFile", "methods": [ @@ -18222,7 +23774,7 @@ { "name": "file_type", "type": "FileType", - "description": "File type, if known" + "description": "File type; pass null if unknown" } ], "description": "Returns information about a file by its remote ID; this is an offline request. Can be used to register a URL as a file for further uploading, or sending as a message. Even the request succeeds, the file can be used only if it is still accessible to the user. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the application", @@ -18231,31 +23783,41 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "loadChats", + "methods": [ + { + "name": "chat_list", + "type": "ChatList", + "description": "The chat list in which to load chats; pass null to load chats from the main chat list" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of chats to be loaded. For optimal performance, the number of loaded chats is chosen by TDLib and can be smaller than the specified limit, even if the end of the list is not reached" + } + ], + "description": "Loads more chats from a chat list. The loaded chats and their positions in the chat list will be sent through updates. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. Returns a 404 error if all chats have been loaded", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "getChats", "methods": [ { "name": "chat_list", "type": "ChatList", - "description": "The chat list in which to return chats" - }, - { - "name": "offset_order", - "type": "int64", - "description": "Chat order to return chats from" - }, - { - "name": "offset_chat_id", - "type": "int53", - "description": "Chat identifier to return chats from" + "description": "The chat list in which to return chats; pass null to get chats from the main chat list" }, { "name": "limit", "type": "int32", - "description": "The maximum number of chats to be returned. It is possible that fewer chats than the limit are returned even if the end of the list is not reached" + "description": "The maximum number of chats to be returned" } ], - "description": "Returns an ordered list of chats in a chat list. Chats are sorted by the pair (chat.position.order, chat.id) in descending order. (For example, to get a list of chats from the beginning, the offset_order should be equal to a biggest signed 64-bit number 9223372036854775807 == 2^63 - 1). For optimal performance the number of returned chats is chosen by the library", + "description": "Returns an ordered list of chats from the beginning of a chat list. For informational purposes only. Use loadChats and updates processing instead to maintain chat lists in a consistent state", "inheritance": "TLBaseClass", "return_type": "chats", "isFunction": true, @@ -18270,7 +23832,7 @@ "description": "Username to be resolved" } ], - "description": "Searches a public chat by its username. Currently only private chats, supergroups and channels can be public. Returns the chat if found; otherwise an error is returned", + "description": "Searches a public chat by its username. Currently, only private chats, supergroups and channels can be public. Returns the chat if found; otherwise an error is returned", "inheritance": "TLBaseClass", "return_type": "chat", "isFunction": true, @@ -18285,7 +23847,7 @@ "description": "Query to search for" } ], - "description": "Searches public chats by looking for specified query in their username and title. Currently only private chats, supergroups and channels can be public. Returns a meaningful number of results. Returns nothing if the length of the searched username prefix is less than 5. Excludes private chats with contacts and chats from the chat list from the results", + "description": "Searches public chats by looking for specified query in their username and title. Currently, only private chats, supergroups and channels can be public. Returns a meaningful number of results. Excludes private chats with contacts and chats from the chat list from the results", "inheritance": "TLBaseClass", "return_type": "chats", "isFunction": true, @@ -18297,7 +23859,7 @@ { "name": "query", "type": "string", - "description": "Query to search for. If the query is empty, returns up to 20 recently found chats" + "description": "Query to search for. If the query is empty, returns up to 50 recently found chats" }, { "name": "limit", @@ -18340,7 +23902,7 @@ "description": "Current user location" } ], - "description": "Returns a list of users and location-based supergroups nearby. The list of users nearby will be updated for 60 seconds after the request by the updates updateUsersNearby. The request should be sent again every 25 seconds with adjusted location to not miss new chats", + "description": "Returns a list of users and location-based supergroups nearby. The list of users nearby will be updated for 60 seconds after the request by the updates updateUsersNearby. The request must be sent again every 25 seconds with adjusted location to not miss new chats", "inheritance": "TLBaseClass", "return_type": "chatsNearby", "isFunction": true, @@ -18425,13 +23987,28 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getRecentlyOpenedChats", + "methods": [ + { + "name": "limit", + "type": "int32", + "description": "The maximum number of chats to be returned" + } + ], + "description": "Returns recently opened chats, this is an offline request. Returns chats in the order of last opening", + "inheritance": "TLBaseClass", + "return_type": "chats", + "isFunction": true, + "isSynchronous": false + }, { "name": "checkChatUsername", "methods": [ { "name": "chat_id", "type": "int53", - "description": "Chat identifier; should be identifier of a supergroup chat, or a channel chat, or a private chat with self, or zero if chat is being created" + "description": "Chat identifier; must be identifier of a supergroup chat, or a channel chat, or a private chat with self, or zero if the chat is being created" }, { "name": "username", @@ -18469,7 +24046,7 @@ "description": "Type of the public chats, for which to check the limit" } ], - "description": "Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached", + "description": "Checks whether the maximum number of owned public chats has been reached. Returns corresponding error if the limit was reached. The limit can be increased with Telegram Premium", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -18478,7 +24055,7 @@ { "name": "getSuitableDiscussionChats", "methods": null, - "description": "Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Basic group chats need to be first upgraded to supergroups before they can be set as a discussion group", + "description": "Returns a list of basic group and supergroup chats, which can be used as a discussion group for a channel. Returned basic group chats must be first upgraded to supergroups before they can be set as a discussion group. To set a returned supergroup as a discussion group, access to its old messages must be enabled using toggleSupergroupIsAllHistoryAvailable first", "inheritance": "TLBaseClass", "return_type": "chats", "isFunction": true, @@ -18487,7 +24064,7 @@ { "name": "getInactiveSupergroupChats", "methods": null, - "description": "Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of joined supergroups and channels and receives CHANNELS_TOO_MUCH error", + "description": "Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of joined supergroups and channels and receives CHANNELS_TOO_MUCH error. Also, the limit can be increased with Telegram Premium", "inheritance": "TLBaseClass", "return_type": "chats", "isFunction": true, @@ -18498,7 +24075,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -18539,15 +24116,15 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached" + "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" }, { "name": "only_local", "type": "Bool", - "description": "If true, returns only messages that are available locally without sending network requests" + "description": "Pass true to get only messages that are available without sending network requests" } ], - "description": "Returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance the number of returned messages is chosen by the library. This is an offline request if only_local is true", + "description": "Returns messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib. This is an offline request if only_local is true", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, @@ -18579,10 +24156,10 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. Fewer messages may be returned than specified by the limit, even if the end of the message thread history has not been reached" + "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than or equal to -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" } ], - "description": "Returns messages in a message thread of a message. Can be used only if message.can_get_message_thread == true. Message thread of a channel message is in the channel's linked supergroup. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance the number of returned messages is chosen by the library", + "description": "Returns messages in a message thread of a message. Can be used only if message.can_get_message_thread == true. Message thread of a channel message is in the channel's linked supergroup. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, @@ -18599,15 +24176,30 @@ { "name": "remove_from_chat_list", "type": "Bool", - "description": "Pass true if the chat should be removed from the chat list" + "description": "Pass true to remove the chat from all chat lists" }, { "name": "revoke", "type": "Bool", - "description": "Pass true to try to delete chat history for all users" + "description": "Pass true to delete chat history for all users" } ], - "description": "Deletes all messages in the chat. Use Chat.can_be_deleted_only_for_self and Chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat", + "description": "Deletes all messages in the chat. Use chat.can_be_deleted_only_for_self and chat.can_be_deleted_for_all_users fields to find whether and how the method can be applied to the chat", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "deleteChat", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Deletes a chat along with all messages in the corresponding chat for all chat members. For group chats this will release the username and remove all members. Use the field chat.can_be_deleted_for_all_users to find whether the method can be applied to the chat", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -18627,9 +24219,9 @@ "description": "Query to search for" }, { - "name": "sender_user_id", - "type": "int32", - "description": "If not 0, only messages sent by the specified user will be returned. Not supported in secret chats" + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender of messages to search for; pass null to search for messages from any sender. Not supported in secret chats" }, { "name": "from_message_id", @@ -18644,12 +24236,12 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached" + "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" }, { "name": "filter", "type": "SearchMessagesFilter", - "description": "Filter for message content in the search results" + "description": "Additional filter for messages to search; pass null to search for all messages" }, { "name": "message_thread_id", @@ -18657,7 +24249,7 @@ "description": "If not 0, only messages in the specified thread will be returned; supergroups only" } ], - "description": "Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages should be used instead), or without an enabled message database. For optimal performance the number of returned messages is chosen by the library", + "description": "Searches for messages with given words in the chat. Returns the results in reverse chronological order, i.e. in order of decreasing message_id. Cannot be used in secret chats with a non-empty query (searchSecretMessages must be used instead), or without an enabled message database. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, @@ -18669,7 +24261,7 @@ { "name": "chat_list", "type": "ChatList", - "description": "Chat list in which to search messages; pass null to search in all chats regardless of their chat list" + "description": "Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported" }, { "name": "query", @@ -18679,7 +24271,7 @@ { "name": "offset_date", "type": "int32", - "description": "The date of the message starting from which the results should be fetched. Use 0 or any date in the future to get results from the last message" + "description": "The date of the message starting from which the results need to be fetched. Use 0 or any date in the future to get results from the last message" }, { "name": "offset_chat_id", @@ -18694,12 +24286,12 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; up to 100. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached" + "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" }, { "name": "filter", "type": "SearchMessagesFilter", - "description": "Filter for message content in the search results; searchMessagesFilterCall, searchMessagesFilterMissedCall, searchMessagesFilterMention, searchMessagesFilterUnreadMention and searchMessagesFilterFailedToSend are unsupported in this function" + "description": "Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterFailedToSend, and searchMessagesFilterPinned are unsupported in this function" }, { "name": "min_date", @@ -18712,7 +24304,7 @@ "description": "If not 0, the maximum date of the messages to return" } ], - "description": "Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance the number of returned messages is chosen by the library", + "description": "Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, @@ -18729,25 +24321,25 @@ { "name": "query", "type": "string", - "description": "Query to search for. If empty, searchChatMessages should be used instead" + "description": "Query to search for. If empty, searchChatMessages must be used instead" }, { "name": "offset", "type": "string", - "description": "Offset of the first entry to return as received from the previous request; use empty string to get first chunk of results" + "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results" }, { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; up to 100. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached" + "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" }, { "name": "filter", "type": "SearchMessagesFilter", - "description": "A filter for message content in the search results" + "description": "Additional filter for messages to search; pass null to search for all messages" } ], - "description": "Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance the number of returned messages is chosen by the library", + "description": "Searches for messages in secret chats. Returns the results in reverse chronological order. For optimal performance, the number of returned messages is chosen by TDLib", "inheritance": "TLBaseClass", "return_type": "foundMessages", "isFunction": true, @@ -18764,20 +24356,55 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; up to 100. Fewer messages may be returned than specified by the limit, even if the end of the message history has not been reached" + "description": "The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" }, { "name": "only_missed", "type": "Bool", - "description": "If true, returns only messages with missed calls" + "description": "Pass true to search only for messages with missed/declined calls" } ], - "description": "Searches for call messages. Returns the results in reverse chronological order (i. e., in order of decreasing message_id). For optimal performance the number of returned messages is chosen by the library", + "description": "Searches for call messages. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). For optimal performance, the number of returned messages is chosen by TDLib", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, "isSynchronous": false }, + { + "name": "searchOutgoingDocumentMessages", + "methods": [ + { + "name": "query", + "type": "string", + "description": "Query to search for in document file name and message caption" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of messages to be returned; up to 100" + } + ], + "description": "Searches for outgoing messages with content of the type messageDocument in all chats except secret chats. Returns the results in reverse chronological order", + "inheritance": "TLBaseClass", + "return_type": "foundMessages", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "deleteAllCallMessages", + "methods": [ + { + "name": "revoke", + "type": "Bool", + "description": "Pass true to delete the messages for all users" + } + ], + "description": "Deletes all call messages", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "searchChatRecentLocationMessages", "methods": [ @@ -18801,7 +24428,7 @@ { "name": "getActiveLiveLocationMessages", "methods": null, - "description": "Returns all active live locations that should be updated by the application. The list is persistent across application restarts only if the message database is used", + "description": "Returns all active live locations that need to be updated by the application. The list is persistent across application restarts only if the message database is used", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, @@ -18827,6 +24454,61 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getChatSparseMessagePositions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat in which to return information about message positions" + }, + { + "name": "filter", + "type": "SearchMessagesFilter", + "description": "Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, and searchMessagesFilterUnreadReaction are unsupported in this function" + }, + { + "name": "from_message_id", + "type": "int53", + "description": "The message identifier from which to return information about message positions" + }, + { + "name": "limit", + "type": "int32", + "description": "The expected number of message positions to be returned; 50-2000. A smaller number of positions can be returned, if there are not enough appropriate messages" + } + ], + "description": "Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation. Returns the results in reverse chronological order (i.e., in order of decreasing message_id). Cannot be used in secret chats or with searchMessagesFilterFailedToSend filter without an enabled message database", + "inheritance": "TLBaseClass", + "return_type": "messagePositions", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getChatMessageCalendar", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat in which to return information about messages" + }, + { + "name": "filter", + "type": "SearchMessagesFilter", + "description": "Filter for message content. Filters searchMessagesFilterEmpty, searchMessagesFilterMention, searchMessagesFilterUnreadMention, and searchMessagesFilterUnreadReaction are unsupported in this function" + }, + { + "name": "from_message_id", + "type": "int53", + "description": "The message identifier from which to return information about messages; use 0 to get results from the last message" + } + ], + "description": "Returns information about the next messages of the specified type in the chat split by days. Returns the results in reverse chronological order. Can return partial result for the last returned day. Behavior of this method depends on the value of the option \"utc_time_offset\"", + "inheritance": "TLBaseClass", + "return_type": "messageCalendar", + "isFunction": true, + "isSynchronous": false + }, { "name": "getChatMessageCount", "methods": [ @@ -18843,7 +24525,7 @@ { "name": "return_local", "type": "Bool", - "description": "If true, returns count that is available locally without sending network requests, returning -1 if the number of messages is unknown" + "description": "Pass true to get the number of messages without sending network requests, or -1 if the number of messages is unknown locally" } ], "description": "Returns approximate number of messages of the specified type in the chat", @@ -18883,20 +24565,35 @@ { "name": "offset", "type": "string", - "description": "Offset of the first entry to return as received from the previous request; use empty string to get first chunk of results" + "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results" }, { "name": "limit", "type": "int32", - "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. Fewer messages may be returned than specified by the limit, even if the end of the list has not been reached" + "description": "The maximum number of messages to be returned; must be positive and can't be greater than 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit" } ], - "description": "Returns forwarded copies of a channel message to another public channels. For optimal performance the number of returned messages is chosen by the library", + "description": "Returns forwarded copies of a channel message to different public channels. For optimal performance, the number of returned messages is chosen by TDLib", "inheritance": "TLBaseClass", "return_type": "foundMessages", "isFunction": true, "isSynchronous": false }, + { + "name": "getChatSponsoredMessage", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat" + } + ], + "description": "Returns sponsored message to be shown in a chat; for channel chats only. Returns a 404 error if there is no sponsored message in the chat", + "inheritance": "TLBaseClass", + "return_type": "sponsoredMessage", + "isFunction": true, + "isSynchronous": false + }, { "name": "removeNotification", "methods": [ @@ -18950,6 +24647,11 @@ "type": "int53", "description": "Identifier of the message" }, + { + "name": "media_timestamp", + "type": "int32", + "description": "If not 0, timestamp from which the video/audio/video note/voice note playing must start, in seconds. The media can be in the message content or in its web page preview" + }, { "name": "for_album", "type": "Bool", @@ -18961,7 +24663,7 @@ "description": "Pass true to create a link to the message as a channel post comment, or from a message thread" } ], - "description": "Returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels. This is an offline request", + "description": "Returns an HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels, or if message.can_get_media_timestamp_links and a media timestamp link is generated. This is an offline request", "inheritance": "TLBaseClass", "return_type": "messageLink", "isFunction": true, @@ -18998,15 +24700,120 @@ { "name": "url", "type": "string", - "description": "The message link in the format \"https://t.me/c/...\", or \"tg://privatepost?...\", or \"https://t.me/username/...\", or \"tg://resolve?...\"" + "description": "The message link" } ], - "description": "Returns information about a public or private message link", + "description": "Returns information about a public or private message link. Can be called for any internal link of the type internalLinkTypeMessage", "inheritance": "TLBaseClass", "return_type": "messageLinkInfo", "isFunction": true, "isSynchronous": false }, + { + "name": "translateText", + "methods": [ + { + "name": "text", + "type": "string", + "description": "Text to translate" + }, + { + "name": "from_language_code", + "type": "string", + "description": "A two-letter ISO 639-1 language code of the language from which the message is translated. If empty, the language will be detected automatically" + }, + { + "name": "to_language_code", + "type": "string", + "description": "A two-letter ISO 639-1 language code of the language to which the message is translated" + } + ], + "description": "Translates a text to the given language. Returns a 404 error if the translation can't be performed", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "recognizeSpeech", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat to which the message belongs" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + } + ], + "description": "Recognizes speech in a voice note message. The message must be successfully sent and must not be scheduled. May return an error with a message \"MSG_VOICE_TOO_LONG\" if the voice note is too long to be recognized", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "rateSpeechRecognition", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat to which the message belongs" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + }, + { + "name": "is_good", + "type": "Bool", + "description": "Pass true if the speech recognition is good" + } + ], + "description": "Rates recognized speech in a voice note message", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getChatAvailableMessageSenders", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Returns list of message sender identifiers, which can be used to send messages in a chat", + "inheritance": "TLBaseClass", + "return_type": "messageSenders", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setChatMessageSender", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_sender_id", + "type": "MessageSender", + "description": "New message sender for the chat" + } + ], + "description": "Selects a message sender to send messages in a chat", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "sendMessage", "methods": [ @@ -19023,17 +24830,17 @@ { "name": "reply_to_message_id", "type": "int53", - "description": "Identifier of the message to reply to or 0" + "description": "Identifier of the replied message; 0 if none" }, { "name": "options", "type": "messageSendOptions", - "description": "Options to be used to send the message" + "description": "Options to be used to send the message; pass null to use default options" }, { "name": "reply_markup", "type": "ReplyMarkup", - "description": "Markup for replying to the message; for bots only" + "description": "Markup for replying to the message; pass null if none; for bots only" }, { "name": "input_message_content", @@ -19063,20 +24870,25 @@ { "name": "reply_to_message_id", "type": "int53", - "description": "Identifier of a message to reply to or 0" + "description": "Identifier of a replied message; 0 if none" }, { "name": "options", "type": "messageSendOptions", - "description": "Options to be used to send the messages" + "description": "Options to be used to send the messages; pass null to use default options" }, { "name": "input_message_contents", "type": "vector", - "description": "Contents of messages to be sent" + "description": "Contents of messages to be sent. At most 10 messages can be added to an album" + }, + { + "name": "only_preview", + "type": "Bool", + "description": "Pass true to get fake messages instead of actually sending them" } ], - "description": "Sends messages grouped together into an album. Currently only photo and video messages can be grouped into an album. Returns sent messages", + "description": "Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be grouped into an album. Documents and audio files can be only grouped in an album with messages of the same type. Returns sent messages", "inheritance": "TLBaseClass", "return_type": "messages", "isFunction": true, @@ -19087,7 +24899,7 @@ "methods": [ { "name": "bot_user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the bot" }, { @@ -19123,12 +24935,12 @@ { "name": "reply_to_message_id", "type": "int53", - "description": "Identifier of a message to reply to or 0" + "description": "Identifier of a replied message; 0 if none" }, { "name": "options", "type": "messageSendOptions", - "description": "Options to be used to send the message" + "description": "Options to be used to send the message; pass null to use default options" }, { "name": "query_id", @@ -19143,7 +24955,7 @@ { "name": "hide_via_bot", "type": "Bool", - "description": "If true, there will be no mention of a bot, via which the message is sent. Can be used only for bots GetOption(\"animation_search_bot_username\"), GetOption(\"photo_search_bot_username\") and GetOption(\"venue_search_bot_username\")" + "description": "Pass true to hide the bot, via which the message is sent. Can be used only for bots GetOption(\"animation_search_bot_username\"), GetOption(\"photo_search_bot_username\"), and GetOption(\"venue_search_bot_username\")" } ], "description": "Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message", @@ -19168,22 +24980,27 @@ { "name": "message_ids", "type": "vector", - "description": "Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order" + "description": "Identifiers of the messages to forward. Message identifiers must be in a strictly increasing order. At most 100 messages can be forwarded simultaneously" }, { "name": "options", "type": "messageSendOptions", - "description": "Options to be used to send the messages" + "description": "Options to be used to send the messages; pass null to use default options" }, { "name": "send_copy", "type": "Bool", - "description": "True, if content of the messages needs to be copied without links to the original messages. Always true if the messages are forwarded to a secret chat" + "description": "Pass true to copy content of the messages without reference to the original sender. Always true if the messages are forwarded to a secret chat or are local" }, { "name": "remove_caption", "type": "Bool", - "description": "True, if media caption of message copies needs to be removed. Ignored if send_copy is false" + "description": "Pass true to remove media captions of message copies. Ignored if send_copy is false" + }, + { + "name": "only_preview", + "type": "Bool", + "description": "Pass true to get fake messages instead of actually forwarding them" } ], "description": "Forwards previously sent messages. Returns the forwarded messages in the same order as the message identifiers passed in message_ids. If a message can't be forwarded, null will be returned instead of the message", @@ -19212,26 +25029,6 @@ "isFunction": true, "isSynchronous": false }, - { - "name": "sendChatSetTtlMessage", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "ttl", - "type": "int32", - "description": "New TTL value, in seconds" - } - ], - "description": "Changes the current TTL setting (sets a new self-destruct timer) in a secret chat and sends the corresponding message", - "inheritance": "TLBaseClass", - "return_type": "message", - "isFunction": true, - "isSynchronous": false - }, { "name": "sendChatScreenshotTakenNotification", "methods": [ @@ -19256,14 +25053,14 @@ "description": "Target chat" }, { - "name": "sender_user_id", - "type": "int32", - "description": "Identifier of the user who will be shown as the sender of the message; may be 0 for channel posts" + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender of the message" }, { "name": "reply_to_message_id", "type": "int53", - "description": "Identifier of the message to reply to or 0" + "description": "Identifier of the replied message; 0 if none" }, { "name": "disable_notification", @@ -19298,7 +25095,7 @@ { "name": "revoke", "type": "Bool", - "description": "Pass true to try to delete messages for all chat members. Always true for supergroups, channels and secret chats" + "description": "Pass true to delete messages for all chat members. Always true for supergroups, channels and secret chats" } ], "description": "Deletes messages", @@ -19308,7 +25105,7 @@ "isSynchronous": false }, { - "name": "deleteChatMessagesFromUser", + "name": "deleteChatMessagesBySender", "methods": [ { "name": "chat_id", @@ -19316,12 +25113,42 @@ "description": "Chat identifier" }, { - "name": "user_id", - "type": "int32", - "description": "User identifier" + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender of messages to delete" } ], - "description": "Deletes all messages sent by the specified user to a chat. Supported only for supergroups; requires can_delete_messages administrator privileges", + "description": "Deletes all messages sent by the specified message sender in a chat. Supported only for supergroups; requires can_delete_messages administrator privileges", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "deleteChatMessagesByDate", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "min_date", + "type": "int32", + "description": "The minimum date of the messages to delete" + }, + { + "name": "max_date", + "type": "int32", + "description": "The maximum date of the messages to delete" + }, + { + "name": "revoke", + "type": "Bool", + "description": "Pass true to delete chat messages for all users; private chats only" + } + ], + "description": "Deletes all messages between the specified dates in a chat. Supported only for private chats and basic groups. Messages sent in the last 30 seconds will not be deleted", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -19343,12 +25170,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup; for bots only" + "description": "The new message reply markup; pass null if none; for bots only" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "New text content of the message. Should be of type InputMessageText" + "description": "New text content of the message. Must be of type inputMessageText" } ], "description": "Edits the text of a message (or a text of a game message). Returns the edited message after the edit is completed on the server side", @@ -19373,12 +25200,22 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup; for bots only" + "description": "The new message reply markup; pass null if none; for bots only" }, { "name": "location", "type": "location", - "description": "New location content of the message; may be null. Pass null to stop sharing the live location" + "description": "New location content of the message; pass null to stop sharing the live location" + }, + { + "name": "heading", + "type": "int32", + "description": "The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown" + }, + { + "name": "proximity_alert_radius", + "type": "int32", + "description": "The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled" } ], "description": "Edits the message content of a live location. Messages can be edited for a limited period of time specified in the live location. Returns the edited message after the edit is completed on the server side", @@ -19403,15 +25240,15 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup; for bots only" + "description": "The new message reply markup; pass null if none; for bots only" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "New content of the message. Must be one of the following types: InputMessageAnimation, InputMessageAudio, InputMessageDocument, InputMessagePhoto or InputMessageVideo" + "description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo" } ], - "description": "Edits the content of a message with an animation, an audio, a document, a photo or a video. The media in the message can't be replaced if the message was set to self-destruct. Media can't be replaced by self-destructing media. Media in an album can be edited only to contain a photo or a video. Returns the edited message after the edit is completed on the server side", + "description": "Edits the content of a message with an animation, an audio, a document, a photo or a video, including message caption. If only the caption needs to be edited, use editMessageCaption instead. The media can't be edited if the message was set to self-destruct or to a self-destructing media. The type of message content in an album can't be changed with exception of replacing a photo with a video or vice versa. Returns the edited message after the edit is completed on the server side", "inheritance": "TLBaseClass", "return_type": "message", "isFunction": true, @@ -19433,12 +25270,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup; for bots only" + "description": "The new message reply markup; pass null if none; for bots only" }, { "name": "caption", "type": "formattedText", - "description": "New message content caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "New message content caption; 0-GetOption(\"message_caption_length_max\") characters; pass null to remove caption" } ], "description": "Edits the message content caption. Returns the edited message after the edit is completed on the server side", @@ -19463,7 +25300,7 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup" + "description": "The new message reply markup; pass null if none" } ], "description": "Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side", @@ -19483,12 +25320,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup" + "description": "The new message reply markup; pass null if none" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "New text content of the message. Should be of type InputMessageText" + "description": "New text content of the message. Must be of type inputMessageText" } ], "description": "Edits the text of an inline text or game message sent via a bot; for bots only", @@ -19508,12 +25345,22 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup" + "description": "The new message reply markup; pass null if none" }, { "name": "location", "type": "location", - "description": "New location content of the message; may be null. Pass null to stop sharing the live location" + "description": "New location content of the message; pass null to stop sharing the live location" + }, + { + "name": "heading", + "type": "int32", + "description": "The new direction in which the location moves, in degrees; 1-360. Pass 0 if unknown" + }, + { + "name": "proximity_alert_radius", + "type": "int32", + "description": "The new maximum distance for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled" } ], "description": "Edits the content of a live location in an inline message sent via a bot; for bots only", @@ -19533,12 +25380,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup; for bots only" + "description": "The new message reply markup; pass null if none; for bots only" }, { "name": "input_message_content", "type": "InputMessageContent", - "description": "New content of the message. Must be one of the following types: InputMessageAnimation, InputMessageAudio, InputMessageDocument, InputMessagePhoto or InputMessageVideo" + "description": "New content of the message. Must be one of the following types: inputMessageAnimation, inputMessageAudio, inputMessageDocument, inputMessagePhoto or inputMessageVideo" } ], "description": "Edits the content of a message with an animation, an audio, a document, a photo or a video in an inline message sent via a bot; for bots only", @@ -19558,12 +25405,12 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup" + "description": "The new message reply markup; pass null if none" }, { "name": "caption", "type": "formattedText", - "description": "New message content caption; 0-GetOption(\"message_caption_length_max\") characters" + "description": "New message content caption; pass null to remove caption; 0-GetOption(\"message_caption_length_max\") characters" } ], "description": "Edits the caption of an inline message sent via a bot; for bots only", @@ -19583,7 +25430,7 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup" + "description": "The new message reply markup; pass null if none" } ], "description": "Edits the reply markup of an inline message sent via a bot; for bots only", @@ -19608,7 +25455,7 @@ { "name": "scheduling_state", "type": "MessageSchedulingState", - "description": "The new message scheduling state. Pass null to send the message immediately" + "description": "The new message scheduling state; pass null to send the message immediately" } ], "description": "Edits the time when a scheduled message will be sent. Scheduling state of all messages in the same album or forwarded together with the message will be also changed", @@ -19617,6 +25464,174 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getEmojiReaction", + "methods": [ + { + "name": "emoji", + "type": "string", + "description": "Text representation of the reaction" + } + ], + "description": "Returns information about a emoji reaction. Returns a 404 error if the reaction is not found", + "inheritance": "TLBaseClass", + "return_type": "emojiReaction", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getCustomEmojiReactionAnimations", + "methods": null, + "description": "Returns TGS files with generic animations for custom emoji reactions", + "inheritance": "TLBaseClass", + "return_type": "files", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getMessageAvailableReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat to which the message belongs" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + }, + { + "name": "row_size", + "type": "int32", + "description": "Number of reaction per row, 5-25" + } + ], + "description": "Returns reactions, which can be added to a message. The list can change after updateActiveEmojiReactions, updateChatAvailableReactions for the chat, or updateMessageInteractionInfo for the message", + "inheritance": "TLBaseClass", + "return_type": "availableReactions", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "clearRecentReactions", + "methods": null, + "description": "Clears the list of recently used reactions", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "addMessageReaction", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat to which the message belongs" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + }, + { + "name": "reaction_type", + "type": "ReactionType", + "description": "Type of the reaction to add" + }, + { + "name": "is_big", + "type": "Bool", + "description": "Pass true if the reaction is added with a big animation" + }, + { + "name": "update_recent_reactions", + "type": "Bool", + "description": "Pass true if the reaction needs to be added to recent reactions" + } + ], + "description": "Adds a reaction to a message. Use getMessageAvailableReactions to receive the list of available reactions for the message", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "removeMessageReaction", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat to which the message belongs" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + }, + { + "name": "reaction_type", + "type": "ReactionType", + "description": "Type of the reaction to remove" + } + ], + "description": "Removes a reaction from a message. A chosen reaction can always be removed", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getMessageAddedReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat to which the message belongs" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the message" + }, + { + "name": "reaction_type", + "type": "ReactionType", + "description": "Type of the reactions to return; pass null to return all added reactions" + }, + { + "name": "offset", + "type": "string", + "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of reactions to be returned; must be positive and can't be greater than 100" + } + ], + "description": "Returns reactions added for a message, along with their sender", + "inheritance": "TLBaseClass", + "return_type": "addedReactions", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setDefaultReactionType", + "methods": [ + { + "name": "reaction_type", + "type": "ReactionType", + "description": "New type of the default reaction" + } + ], + "description": "Changes type of default reaction for the current user", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "getTextEntities", "methods": [ @@ -19646,7 +25661,7 @@ "description": "Text parse mode" } ], - "description": "Parses Bold, Italic, Underline, Strikethrough, Code, Pre, PreCode, TextUrl and MentionName entities contained in the text. Can be called synchronously", + "description": "Parses Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, Code, Pre, PreCode, TextUrl and MentionName entities contained in the text. Can be called synchronously", "inheritance": "TLBaseClass", "return_type": "formattedText", "isFunction": true, @@ -19658,7 +25673,7 @@ { "name": "text", "type": "formattedText", - "description": "The text to parse. For example, \"__italic__ ~~strikethrough~~ **bold** `code` ```pre``` __[italic__ text_url](telegram.org) __italic**bold italic__bold**\"" + "description": "The text to parse. For example, \"__italic__ ~~strikethrough~~ ||spoiler|| **bold** `code` ```pre``` __[italic__ text_url](telegram.org) __italic**bold italic__bold**\"" } ], "description": "Parses Markdown entities in a human-friendly format, ignoring markup errors. Can be called synchronously", @@ -19787,6 +25802,21 @@ "isFunction": true, "isSynchronous": true }, + { + "name": "getThemeParametersJsonString", + "methods": [ + { + "name": "theme", + "type": "themeParameters", + "description": "Theme parameters to convert to JSON" + } + ], + "description": "Converts a themeParameters object to corresponding JSON-serialized string. Can be called synchronously", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": true + }, { "name": "setPollAnswer", "methods": [ @@ -19838,10 +25868,10 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of users to be returned; must be positive and can't be greater than 50. Fewer users may be returned than specified by the limit, even if the end of the voter list has not been reached" + "description": "The maximum number of users to be returned; must be positive and can't be greater than 50. For optimal performance, the number of returned users is chosen by TDLib and can be smaller than the specified limit, even if the end of the voter list has not been reached" } ], - "description": "Returns users voted for the specified option in a non-anonymous polls. For the optimal performance the number of returned users is chosen by the library", + "description": "Returns users voted for the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib", "inheritance": "TLBaseClass", "return_type": "users", "isFunction": true, @@ -19863,7 +25893,7 @@ { "name": "reply_markup", "type": "ReplyMarkup", - "description": "The new message reply markup; for bots only" + "description": "The new message reply markup; pass null if none; for bots only" } ], "description": "Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag set", @@ -19902,7 +25932,7 @@ }, { "name": "button_id", - "type": "int32", + "type": "int53", "description": "Button identifier" } ], @@ -19927,13 +25957,13 @@ }, { "name": "button_id", - "type": "int32", + "type": "int53", "description": "Button identifier" }, { "name": "allow_write_access", "type": "Bool", - "description": "True, if the user allowed the bot to send them messages" + "description": "Pass true to allow the bot to send messages to the current user" } ], "description": "Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button", @@ -19947,7 +25977,7 @@ "methods": [ { "name": "bot_user_id", - "type": "int32", + "type": "int53", "description": "The identifier of the target bot" }, { @@ -19958,7 +25988,7 @@ { "name": "user_location", "type": "location", - "description": "Location of the user, only if needed" + "description": "Location of the user; pass null if unknown or the bot doesn't need user's location" }, { "name": "query", @@ -19988,7 +26018,7 @@ { "name": "is_personal", "type": "Bool", - "description": "True, if the result of the query can be cached for the specified user" + "description": "Pass true if results may be cached and returned only for the user that sent the query. By default, results may be returned to any user who sends the same query" }, { "name": "results", @@ -20008,7 +26038,7 @@ { "name": "switch_pm_text", "type": "string", - "description": "If non-empty, this text should be shown on the button that opens a private chat with the bot and sends a start message to the bot with the parameter switch_pm_parameter" + "description": "If non-empty, this text must be shown on the button that opens a private chat with the bot and sends a start message to the bot with the parameter switch_pm_parameter" }, { "name": "switch_pm_parameter", @@ -20022,6 +26052,136 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getWebAppUrl", + "methods": [ + { + "name": "bot_user_id", + "type": "int53", + "description": "Identifier of the target bot" + }, + { + "name": "url", + "type": "string", + "description": "The URL from the keyboardButtonTypeWebApp button" + }, + { + "name": "theme", + "type": "themeParameters", + "description": "Preferred Web App theme; pass null to use the default theme" + }, + { + "name": "application_name", + "type": "string", + "description": "Short name of the application; 0-64 English letters, digits, and underscores" + } + ], + "description": "Returns an HTTPS URL of a Web App to open after keyboardButtonTypeWebApp button is pressed", + "inheritance": "TLBaseClass", + "return_type": "httpUrl", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "sendWebAppData", + "methods": [ + { + "name": "bot_user_id", + "type": "int53", + "description": "Identifier of the target bot" + }, + { + "name": "button_text", + "type": "string", + "description": "Text of the keyboardButtonTypeWebApp button, which opened the Web App" + }, + { + "name": "data", + "type": "string", + "description": "Received data" + } + ], + "description": "Sends data received from a keyboardButtonTypeWebApp Web App to a bot", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "openWebApp", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat in which the Web App is opened" + }, + { + "name": "bot_user_id", + "type": "int53", + "description": "Identifier of the bot, providing the Web App" + }, + { + "name": "url", + "type": "string", + "description": "The URL from an inlineKeyboardButtonTypeWebApp button, a botMenuButton button, or an internalLinkTypeAttachmentMenuBot link, or an empty string otherwise" + }, + { + "name": "theme", + "type": "themeParameters", + "description": "Preferred Web App theme; pass null to use the default theme" + }, + { + "name": "application_name", + "type": "string", + "description": "Short name of the application; 0-64 English letters, digits, and underscores" + }, + { + "name": "reply_to_message_id", + "type": "int53", + "description": "Identifier of the replied message for the message sent by the Web App; 0 if none" + } + ], + "description": "Informs TDLib that a Web App is being opened from attachment menu, a botMenuButton button, an internalLinkTypeAttachmentMenuBot link, or an inlineKeyboardButtonTypeWebApp button. For each bot, a confirmation alert about data sent to the bot must be shown once", + "inheritance": "TLBaseClass", + "return_type": "webAppInfo", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "closeWebApp", + "methods": [ + { + "name": "web_app_launch_id", + "type": "int64", + "description": "Identifier of Web App launch, received from openWebApp" + } + ], + "description": "Informs TDLib that a previously opened Web App was closed", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "answerWebAppQuery", + "methods": [ + { + "name": "web_app_query_id", + "type": "string", + "description": "Identifier of the Web App query" + }, + { + "name": "result", + "type": "InputInlineQueryResult", + "description": "The result of the query" + } + ], + "description": "Sets the result of interaction with a Web App and sends corresponding message on behalf of the user to the chat from which the query originated; for bots only", + "inheritance": "TLBaseClass", + "return_type": "sentWebAppMessage", + "isFunction": true, + "isSynchronous": false + }, { "name": "getCallbackQueryAnswer", "methods": [ @@ -20063,7 +26223,7 @@ { "name": "show_alert", "type": "Bool", - "description": "If true, an alert should be shown to the user instead of a toast notification" + "description": "Pass true to show an alert to the user instead of a toast notification" }, { "name": "url", @@ -20143,11 +26303,11 @@ { "name": "edit_message", "type": "Bool", - "description": "True, if the message should be edited" + "description": "Pass true to edit the game message to include the current scoreboard" }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -20178,11 +26338,11 @@ { "name": "edit_message", "type": "Bool", - "description": "True, if the message should be edited" + "description": "Pass true to edit the game message to include the current scoreboard" }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -20217,7 +26377,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" } ], @@ -20237,7 +26397,7 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" } ], @@ -20261,7 +26421,7 @@ "description": "The message identifier of the used keyboard" } ], - "description": "Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a ForceReply reply markup has been used. UpdateChatReplyMarkup will be sent if the reply markup will be changed", + "description": "Deletes the default reply markup from a chat. Must be called after a one-time keyboard or a ForceReply reply markup has been used. UpdateChatReplyMarkup will be sent if the reply markup is changed", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20283,7 +26443,7 @@ { "name": "action", "type": "ChatAction", - "description": "The action description" + "description": "The action description; pass null to cancel the currently active action" } ], "description": "Sends a notification about user activity in a chat", @@ -20343,10 +26503,10 @@ { "name": "force_read", "type": "Bool", - "description": "True, if messages in closed chats should be marked as read by the request" + "description": "Pass true to mark as read the specified messages even the chat is closed" } ], - "description": "Informs TDLib that messages are being viewed by the user. Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels)", + "description": "Informs TDLib that messages are being viewed by the user. Sponsored messages must be marked as viewed only when the entire text of the message is shown on the screen (excluding the button). Many useful activities depend on whether the messages are currently being viewed or not (e.g., marking messages as read, incrementing a view counter, updating a view counter, removing deleted messages in supergroups and channels)", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20372,6 +26532,76 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "clickAnimatedEmojiMessage", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier of the message" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the clicked message" + } + ], + "description": "Informs TDLib that a message with an animated emoji was clicked by the user. Returns a big animated sticker to be played or a 404 error if usual animation needs to be played", + "inheritance": "TLBaseClass", + "return_type": "sticker", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getInternalLinkType", + "methods": [ + { + "name": "link", + "type": "string", + "description": "The link" + } + ], + "description": "Returns information about the type of an internal link. Returns a 404 error if the link is not internal. Can be called before authorization", + "inheritance": "TLBaseClass", + "return_type": "InternalLinkType", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getExternalLinkInfo", + "methods": [ + { + "name": "link", + "type": "string", + "description": "The link" + } + ], + "description": "Returns information about an action to be done when the current user clicks an external link. Don't use this method for links from secret chats if web page preview is disabled in secret chats", + "inheritance": "TLBaseClass", + "return_type": "LoginUrlInfo", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getExternalLink", + "methods": [ + { + "name": "link", + "type": "string", + "description": "The HTTP link" + }, + { + "name": "allow_write_access", + "type": "Bool", + "description": "Pass true if the current user allowed the bot, returned in getExternalLinkInfo, to send them messages" + } + ], + "description": "Returns an HTTP URL which can be used to automatically authorize the current user on a website after clicking an HTTP link. Use the method getExternalLinkInfo to find whether a prior user confirmation is needed", + "inheritance": "TLBaseClass", + "return_type": "httpUrl", + "isFunction": true, + "isSynchronous": false + }, { "name": "readAllChatMentions", "methods": [ @@ -20387,18 +26617,33 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "readAllChatReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Marks all reactions in a chat as read", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "createPrivateChat", "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { "name": "force", "type": "Bool", - "description": "If true, the chat will be created without network request. In this case all information about the chat except its type, title and photo can be incorrect" + "description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect" } ], "description": "Returns an existing chat corresponding to a given user", @@ -20412,13 +26657,13 @@ "methods": [ { "name": "basic_group_id", - "type": "int32", + "type": "int53", "description": "Basic group identifier" }, { "name": "force", "type": "Bool", - "description": "If true, the chat will be created without network request. In this case all information about the chat except its type, title and photo can be incorrect" + "description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect" } ], "description": "Returns an existing chat corresponding to a known basic group", @@ -20432,13 +26677,13 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Supergroup or channel identifier" }, { "name": "force", "type": "Bool", - "description": "If true, the chat will be created without network request. In this case all information about the chat except its type, title and photo can be incorrect" + "description": "Pass true to create the chat without a network request. In this case all information about the chat except its type, title and photo can be incorrect" } ], "description": "Returns an existing chat corresponding to a known supergroup or channel", @@ -20467,7 +26712,7 @@ "methods": [ { "name": "user_ids", - "type": "vector", + "type": "vector", "description": "Identifiers of users to be added to the basic group" }, { @@ -20493,7 +26738,7 @@ { "name": "is_channel", "type": "Bool", - "description": "True, if a channel chat should be created" + "description": "Pass true to create a channel chat" }, { "name": "description", @@ -20503,7 +26748,12 @@ { "name": "location", "type": "chatLocation", - "description": "Chat location if a location-based supergroup is being created" + "description": "Chat location if a location-based supergroup is being created; pass null to create an ordinary supergroup chat" + }, + { + "name": "for_import", + "type": "Bool", + "description": "Pass true to create a supergroup for importing messages using importMessage" } ], "description": "Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat", @@ -20517,7 +26767,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the target user" } ], @@ -20601,7 +26851,7 @@ "description": "Chat filter" } ], - "description": "Creates new chat filter. Returns information about the created chat filter", + "description": "Creates new chat filter. Returns information about the created chat filter. There can be up to GetOption(\"chat_filter_count_max\") chat filters, but the limit can be increased with Telegram Premium", "inheritance": "TLBaseClass", "return_type": "chatFilterInfo", "isFunction": true, @@ -20649,6 +26899,11 @@ "name": "chat_filter_ids", "type": "vector", "description": "Identifiers of chat filters in the new correct order" + }, + { + "name": "main_chat_list_position", + "type": "int32", + "description": "Position of the main chat list among chat filters, 0-based. Can be non-zero only for Premium users" } ], "description": "Changes the order of chat filters", @@ -20695,7 +26950,7 @@ "description": "New title of the chat; 1-128 characters" } ], - "description": "Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info rights", + "description": "Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info administrator right", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20712,10 +26967,30 @@ { "name": "photo", "type": "InputChatPhoto", - "description": "New chat photo. Pass null to delete the chat photo" + "description": "New chat photo; pass null to delete the chat photo" } ], - "description": "Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info rights", + "description": "Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info administrator right", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setChatMessageTtl", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "ttl", + "type": "int32", + "description": "New TTL value, in seconds; unless the chat is secret, it must be from 0 up to 365 * 86400 and be divisible by 86400" + } + ], + "description": "Changes the message TTL in a chat. Requires can_delete_messages administrator right in basic groups, supergroups and channels Message TTL can't be changed in a chat with the current user (Saved Messages) and the chat 777000 (Telegram).", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20741,6 +27016,26 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "setChatTheme", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "theme_name", + "type": "string", + "description": "Name of the new chat theme; pass an empty string to return the default theme" + } + ], + "description": "Changes the chat theme. Supported only in private and secret chats", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "setChatDraftMessage", "methods": [ @@ -20757,7 +27052,7 @@ { "name": "draft_message", "type": "draftMessage", - "description": "New draft message; may be null" + "description": "New draft message; pass null to remove the draft" } ], "description": "Changes the draft message in a chat", @@ -20777,7 +27072,7 @@ { "name": "notification_settings", "type": "chatNotificationSettings", - "description": "New notification settings for the chat. If the chat is muted for more than 1 week, it is considered to be muted forever" + "description": "New notification settings for the chat. If the chat is muted for more than 366 days, it is considered to be muted forever" } ], "description": "Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can't be changed", @@ -20786,6 +27081,26 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "toggleChatHasProtectedContent", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "has_protected_content", + "type": "Bool", + "description": "New value of has_protected_content" + } + ], + "description": "Changes the ability of users to save, forward, or copy chat content. Supported only for basic groups, supergroups and channels. Requires owner privileges", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "toggleChatIsMarkedAsUnread", "methods": [ @@ -20806,26 +27121,6 @@ "isFunction": true, "isSynchronous": false }, - { - "name": "toggleChatIsBlocked", - "methods": [ - { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier" - }, - { - "name": "is_blocked", - "type": "Bool", - "description": "New value of is_blocked" - } - ], - "description": "Changes the block state of a chat. Currently, only private chats and supergroups can be blocked", - "inheritance": "TLBaseClass", - "return_type": "ok", - "isFunction": true, - "isSynchronous": false - }, { "name": "toggleChatDefaultDisableNotification", "methods": [ @@ -20846,6 +27141,26 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "setChatAvailableReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat" + }, + { + "name": "available_reactions", + "type": "ChatAvailableReactions", + "description": "Reactions available in the chat. All emoji reactions must be active" + } + ], + "description": "Changes reactions, available in a chat. Available for basic groups, supergroups, and channels. Requires can_change_info administrator right", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "setChatClientData", "methods": [ @@ -20880,7 +27195,7 @@ "description": "New chat description; 0-255 characters" } ], - "description": "Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info rights", + "description": "Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info administrator right", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20897,10 +27212,10 @@ { "name": "discussion_chat_id", "type": "int53", - "description": "Identifier of a new channel's discussion group. Use 0 to remove the discussion group. Use the method getSuitableDiscussionChats to find all suitable groups. Basic group chats need to be first upgraded to supergroup chats. If new chat members don't have access to old messages in the supergroup, then toggleSupergroupIsAllHistoryAvailable needs to be used first to change that" + "description": "Identifier of a new channel's discussion group. Use 0 to remove the discussion group. Use the method getSuitableDiscussionChats to find all suitable groups. Basic group chats must be first upgraded to supergroup chats. If new chat members don't have access to old messages in the supergroup, then toggleSupergroupIsAllHistoryAvailable must be used first to change that" } ], - "description": "Changes the discussion group of a channel chat; requires can_change_info rights in the channel if it is specified", + "description": "Changes the discussion group of a channel chat; requires can_change_info administrator right in the channel if it is specified", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20937,7 +27252,7 @@ { "name": "slow_mode_delay", "type": "int32", - "description": "New slow mode delay for the chat; must be one of 0, 10, 30, 60, 300, 900, 3600" + "description": "New slow mode delay for the chat, in seconds; must be one of 0, 10, 30, 60, 300, 900, 3600" } ], "description": "Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members rights", @@ -20962,10 +27277,15 @@ { "name": "disable_notification", "type": "Bool", - "description": "True, if there should be no notification about the pinned message" + "description": "Pass true to disable notification about the pinned message. Notifications are always disabled in channels and private chats" + }, + { + "name": "only_for_self", + "type": "Bool", + "description": "Pass true to pin the message only for self; private chats only" } ], - "description": "Pins a message in a chat; requires can_pin_messages rights", + "description": "Pins a message in a chat; requires can_pin_messages rights or can_edit_messages rights in the channel", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20978,9 +27298,29 @@ "name": "chat_id", "type": "int53", "description": "Identifier of the chat" + }, + { + "name": "message_id", + "type": "int53", + "description": "Identifier of the removed pinned message" } ], - "description": "Removes the pinned message from a chat; requires can_pin_messages rights in the group or channel", + "description": "Removes a pinned message from a chat; requires can_pin_messages rights in the group or can_edit_messages rights in the channel", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "unpinAllChatMessages", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of the chat" + } + ], + "description": "Removes all pinned messages from a chat; requires can_pin_messages rights in the group or can_edit_messages rights in the channel", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -20995,7 +27335,7 @@ "description": "Chat identifier" } ], - "description": "Adds current user as a new member to a chat. Private and secret chats can't be joined using this method", + "description": "Adds the current user as a new member to a chat. Private and secret chats can't be joined using this method. May return an error with a message \"INVITE_REQUEST_SENT\" if only a join request was created", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21010,7 +27350,7 @@ "description": "Chat identifier" } ], - "description": "Removes current user from chat members. Private and secret chats can't be left using this method", + "description": "Removes the current user from chat members. Private and secret chats can't be left using this method", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21026,16 +27366,16 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user" }, { "name": "forward_limit", "type": "int32", - "description": "The number of earlier messages from the chat to be forwarded to the new member; up to 100. Ignored for supergroups and channels" + "description": "The number of earlier messages from the chat to be forwarded to the new member; up to 100. Ignored for supergroups and channels, or if the added user is a bot" } ], - "description": "Adds a new member to a chat. Members can't be added to private or secret chats. Members will not be added until the chat state has been synchronized with the server", + "description": "Adds a new member to a chat. Members can't be added to private or secret chats", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21051,11 +27391,11 @@ }, { "name": "user_ids", - "type": "vector", - "description": "Identifiers of the users to be added to the chat" + "type": "vector", + "description": "Identifiers of the users to be added to the chat. The maximum number of added users is 20 for supergroups and 100 for channels" } ], - "description": "Adds multiple new members to a chat. Currently this option is only available for supergroups and channels. This option can't be used to join a chat. Members can't be added to a channel if it has more than 200 members. Members will not be added until the chat state has been synchronized with the server", + "description": "Adds multiple new members to a chat. Currently, this method is only available for supergroups and channels. This method can't be used to join a chat. Members can't be added to a channel if it has more than 200 members", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21070,9 +27410,9 @@ "description": "Chat identifier" }, { - "name": "user_id", - "type": "int32", - "description": "User identifier" + "name": "member_id", + "type": "MessageSender", + "description": "Member identifier. Chats can be only banned and unbanned in supergroups and channels" }, { "name": "status", @@ -21080,7 +27420,37 @@ "description": "The new status of the member in the chat" } ], - "description": "Changes the status of a chat member, needs appropriate privileges. This function is currently not suitable for adding new members to the chat and transferring chat ownership; instead, use addChatMember or transferChatOwnership. The chat member status will not be changed until it has been synchronized with the server", + "description": "Changes the status of a chat member, needs appropriate privileges. This function is currently not suitable for transferring chat ownership; use transferChatOwnership instead. Use addChatMember or banChatMember if some additional parameters needs to be passed", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "banChatMember", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "member_id", + "type": "MessageSender", + "description": "Member identifier" + }, + { + "name": "banned_until_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the user will be unbanned; 0 if never. If the user is banned for more than 366 days or for less than 30 seconds from the current time, the user is considered to be banned forever. Ignored in basic groups and if a chat is banned" + }, + { + "name": "revoke_messages", + "type": "Bool", + "description": "Pass true to delete all messages in the chat for the user that is being removed. Always true for supergroups and channels" + } + ], + "description": "Bans a member in a chat. Members can't be banned in private or secret chats. In supergroups and channels, the user will not be able to return to the group on their own using invite links, etc., unless unbanned first", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21105,13 +27475,13 @@ }, { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user to which transfer the ownership. The ownership can't be transferred to a bot or to a deleted user" }, { "name": "password", "type": "string", - "description": "The password of the current user" + "description": "The 2-step verification password of the current user" } ], "description": "Changes the owner of a chat. The current user must be a current owner of the chat. Use the method canTransferOwnership to check whether the ownership can be transferred from the current session. Available only for supergroups and channel chats", @@ -21129,9 +27499,9 @@ "description": "Chat identifier" }, { - "name": "user_id", - "type": "int32", - "description": "User identifier" + "name": "member_id", + "type": "MessageSender", + "description": "Member identifier" } ], "description": "Returns information about a single member of a chat", @@ -21156,12 +27526,12 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of users to be returned" + "description": "The maximum number of users to be returned; up to 200" }, { "name": "filter", "type": "ChatMembersFilter", - "description": "The type of users to return. By default, chatMembersFilterMembers" + "description": "The type of users to search for; pass null to search among all chat members" } ], "description": "Searches for a specified query in the first name, last name and username of the members of a specified chat. Requires administrator rights in channels", @@ -21191,10 +27561,64 @@ { "name": "exclude_secret_chats", "type": "Bool", - "description": "If true, local draft messages in secret chats will not be cleared" + "description": "Pass true to keep local message drafts in secret chats" } ], - "description": "Clears draft messages in all chats", + "description": "Clears message drafts in all chats", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getSavedNotificationSound", + "methods": [ + { + "name": "notification_sound_id", + "type": "int64", + "description": "Identifier of the notification sound" + } + ], + "description": "Returns saved notification sound by its identifier. Returns a 404 error if there is no saved notification sound with the specified identifier", + "inheritance": "TLBaseClass", + "return_type": "notificationSounds", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getSavedNotificationSounds", + "methods": null, + "description": "Returns list of saved notification sounds. If a sound isn't in the list, then default sound needs to be used", + "inheritance": "TLBaseClass", + "return_type": "notificationSounds", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "addSavedNotificationSound", + "methods": [ + { + "name": "sound", + "type": "InputFile", + "description": "Notification sound file to add" + } + ], + "description": "Adds a new notification sound to the list of saved notification sounds. The new notification sound is added to the top of the list. If it is already in the list, its position isn't changed", + "inheritance": "TLBaseClass", + "return_type": "notificationSound", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "removeSavedNotificationSound", + "methods": [ + { + "name": "notification_sound_id", + "type": "int64", + "description": "Identifier of the notification sound" + } + ], + "description": "Removes a notification sound from the list of saved notification sounds", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21206,12 +27630,12 @@ { "name": "scope", "type": "NotificationSettingsScope", - "description": "If specified, only chats from the specified scope will be returned" + "description": "If specified, only chats from the scope will be returned; pass null to return chats from all scopes" }, { "name": "compare_sound", "type": "Bool", - "description": "If true, also chats with non-default sound will be returned" + "description": "Pass true to include in the response chats with only non-default sound" } ], "description": "Returns list of chats with non-default notification settings", @@ -21258,7 +27682,7 @@ { "name": "resetAllNotificationSettings", "methods": null, - "description": "Resets all notification settings to their default values. By default, all chats are unmuted, the sound is set to \"default\" and message previews are shown", + "description": "Resets all notification settings to their default values. By default, all chats are unmuted and message previews are shown", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21280,10 +27704,10 @@ { "name": "is_pinned", "type": "Bool", - "description": "True, if the chat is pinned" + "description": "Pass true to pin the chat; pass false to unpin it" } ], - "description": "Changes the pinned state of a chat. There can be up to GetOption(\"pinned_chat_count_max\")/GetOption(\"pinned_archived_chat_count_max\") pinned non-secret chats and the same number of secret chats in the main/arhive chat list", + "description": "Changes the pinned state of a chat. There can be up to GetOption(\"pinned_chat_count_max\")/GetOption(\"pinned_archived_chat_count_max\") pinned non-secret chats and the same number of secret chats in the main/archive chat list. The limit can be increased with Telegram Premium", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21309,6 +27733,77 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getAttachmentMenuBot", + "methods": [ + { + "name": "bot_user_id", + "type": "int53", + "description": "Bot's user identifier" + } + ], + "description": "Returns information about a bot that can be added to attachment menu", + "inheritance": "TLBaseClass", + "return_type": "attachmentMenuBot", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleBotIsAddedToAttachmentMenu", + "methods": [ + { + "name": "bot_user_id", + "type": "int53", + "description": "Bot's user identifier" + }, + { + "name": "is_added", + "type": "Bool", + "description": "Pass true to add the bot to attachment menu; pass false to remove the bot from attachment menu" + } + ], + "description": "Adds or removes a bot to attachment menu. Bot can be added to attachment menu, only if userTypeBot.can_be_added_to_attachment_menu == true", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getThemedEmojiStatuses", + "methods": null, + "description": "Returns up to 8 themed emoji statuses, which color must be changed to the color of the Telegram Premium badge", + "inheritance": "TLBaseClass", + "return_type": "emojiStatuses", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getRecentEmojiStatuses", + "methods": null, + "description": "Returns recent emoji statuses", + "inheritance": "TLBaseClass", + "return_type": "emojiStatuses", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getDefaultEmojiStatuses", + "methods": null, + "description": "Returns default emoji statuses", + "inheritance": "TLBaseClass", + "return_type": "emojiStatuses", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "clearRecentEmojiStatuses", + "methods": null, + "description": "Clears the list of recently used emoji statuses", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "downloadFile", "methods": [ @@ -21320,22 +27815,22 @@ { "name": "priority", "type": "int32", - "description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile was called will be downloaded first" + "description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first" }, { "name": "offset", - "type": "int32", - "description": "The starting position from which the file should be downloaded" + "type": "int53", + "description": "The starting position from which the file needs to be downloaded" }, { "name": "limit", - "type": "int32", - "description": "Number of bytes which should be downloaded starting from the \"offset\" position before the download will be automatically cancelled; use 0 to download without a limit" + "type": "int53", + "description": "Number of bytes which need to be downloaded starting from the \"offset\" position before the download will automatically be canceled; use 0 to download without a limit" }, { "name": "synchronous", "type": "Bool", - "description": "If false, this request returns file state just after the download has been started. If true, this request returns file state only after the download has succeeded, has failed, has been cancelled or a new downloadFile request with different offset/limit parameters was sent" + "description": "Pass true to return response only after the file download has succeeded, has failed, has been canceled, or a new downloadFile request with different offset/limit parameters was sent; pass false to return file state immediately, just after the download has been started" } ], "description": "Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates", @@ -21354,13 +27849,13 @@ }, { "name": "offset", - "type": "int32", - "description": "Offset from which downloaded prefix size should be calculated" + "type": "int53", + "description": "Offset from which downloaded prefix size needs to be calculated" } ], - "description": "Returns file downloaded prefix size from a given offset", + "description": "Returns file downloaded prefix size from a given offset, in bytes", "inheritance": "TLBaseClass", - "return_type": "count", + "return_type": "fileDownloadedPrefixSize", "isFunction": true, "isSynchronous": false }, @@ -21385,7 +27880,27 @@ "isSynchronous": false }, { - "name": "uploadFile", + "name": "getSuggestedFileName", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "Identifier of the file" + }, + { + "name": "directory", + "type": "string", + "description": "Directory in which the file is supposed to be saved" + } + ], + "description": "Returns suggested name for saving a file in a given directory", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "preliminaryUploadFile", "methods": [ { "name": "file", @@ -21395,22 +27910,22 @@ { "name": "file_type", "type": "FileType", - "description": "File type" + "description": "File type; pass null if unknown" }, { "name": "priority", "type": "int32", - "description": "Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which uploadFile was called will be uploaded first" + "description": "Priority of the upload (1-32). The higher the priority, the earlier the file will be uploaded. If the priorities of two files are equal, then the first one for which preliminaryUploadFile was called will be uploaded first" } ], - "description": "Asynchronously uploads a file to the cloud without sending it in a message. updateFile will be used to notify about upload progress and successful completion of the upload. The file will not have a persistent remote identifier until it will be sent in a message", + "description": "Preliminary uploads a file to the cloud before sending it in a message, which can be useful for uploading of being recorded voice and video notes. Updates updateFile will be used to notify about upload progress and successful completion of the upload. The file will not have a persistent remote identifier until it will be sent in a message", "inheritance": "TLBaseClass", "return_type": "file", "isFunction": true, "isSynchronous": false }, { - "name": "cancelUploadFile", + "name": "cancelPreliminaryUploadFile", "methods": [ { "name": "file_id", @@ -21418,7 +27933,7 @@ "description": "Identifier of the file to stop uploading" } ], - "description": "Stops the uploading of a file. Supported only for files uploaded by using uploadFile. For other files the behavior is undefined", + "description": "Stops the preliminary uploading of a file. Supported only for files uploaded by using preliminaryUploadFile. For other files the behavior is undefined", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -21434,7 +27949,7 @@ }, { "name": "offset", - "type": "int32", + "type": "int53", "description": "The offset from which to write the data to the file" }, { @@ -21459,12 +27974,12 @@ }, { "name": "expected_size", - "type": "int32", + "type": "int53", "description": "Expected size of the generated file, in bytes; 0 if unknown" }, { "name": "local_prefix_size", - "type": "int32", + "type": "int53", "description": "The number of bytes already generated" } ], @@ -21485,7 +28000,7 @@ { "name": "error", "type": "error", - "description": "If set, means that file generation has failed and should be terminated" + "description": "If passed, the file generation has failed and must be terminated; pass null if the file generation succeeded" } ], "description": "Finishes the file generation", @@ -21504,12 +28019,12 @@ }, { "name": "offset", - "type": "int32", + "type": "int53", "description": "The offset from which to read the file" }, { "name": "count", - "type": "int32", + "type": "int53", "description": "Number of bytes to read. An error will be returned if there are not enough bytes available in the file from the specified position. Pass 0 to read all available data from the specified position" } ], @@ -21535,7 +28050,207 @@ "isSynchronous": false }, { - "name": "generateChatInviteLink", + "name": "addFileToDownloads", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "Identifier of the file to download" + }, + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier of the message with the file" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + }, + { + "name": "priority", + "type": "int32", + "description": "Priority of the download (1-32). The higher the priority, the earlier the file will be downloaded. If the priorities of two files are equal, then the last one for which downloadFile/addFileToDownloads was called will be downloaded first" + } + ], + "description": "Adds a file from a message to the list of file downloads. Download progress and completion of the download will be notified through updateFile updates. If message database is used, the list of file downloads is persistent across application restarts. The downloading is independent from download using downloadFile, i.e. it continues if downloadFile is canceled or is used to download a part of the file", + "inheritance": "TLBaseClass", + "return_type": "file", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleDownloadIsPaused", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "Identifier of the downloaded file" + }, + { + "name": "is_paused", + "type": "Bool", + "description": "Pass true if the download is paused" + } + ], + "description": "Changes pause state of a file in the file download list", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleAllDownloadsArePaused", + "methods": [ + { + "name": "are_paused", + "type": "Bool", + "description": "Pass true to pause all downloads; pass false to unpause them" + } + ], + "description": "Changes pause state of all files in the file download list", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "removeFileFromDownloads", + "methods": [ + { + "name": "file_id", + "type": "int32", + "description": "Identifier of the downloaded file" + }, + { + "name": "delete_from_cache", + "type": "Bool", + "description": "Pass true to delete the file from the TDLib file cache" + } + ], + "description": "Removes a file from the file download list", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "removeAllFilesFromDownloads", + "methods": [ + { + "name": "only_active", + "type": "Bool", + "description": "Pass true to remove only active downloads, including paused" + }, + { + "name": "only_completed", + "type": "Bool", + "description": "Pass true to remove only completed downloads" + }, + { + "name": "delete_from_cache", + "type": "Bool", + "description": "Pass true to delete the file from the TDLib file cache" + } + ], + "description": "Removes all files from the file download list", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "searchFileDownloads", + "methods": [ + { + "name": "query", + "type": "string", + "description": "Query to search for; may be empty to return all downloaded files" + }, + { + "name": "only_active", + "type": "Bool", + "description": "Pass true to search only for active downloads, including paused" + }, + { + "name": "only_completed", + "type": "Bool", + "description": "Pass true to search only for completed downloads" + }, + { + "name": "offset", + "type": "string", + "description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of files to be returned" + } + ], + "description": "Searches for files in the file download list or recently downloaded files from the list", + "inheritance": "TLBaseClass", + "return_type": "foundFileDownloads", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getMessageFileType", + "methods": [ + { + "name": "message_file_head", + "type": "string", + "description": "Beginning of the message file; up to 100 first lines" + } + ], + "description": "Returns information about a file with messages exported from another application", + "inheritance": "TLBaseClass", + "return_type": "MessageFileType", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getMessageImportConfirmationText", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of a chat to which the messages will be imported. It must be an identifier of a private chat with a mutual contact or an identifier of a supergroup chat with can_change_info administrator right" + } + ], + "description": "Returns a confirmation text to be shown to the user before starting message import", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "importMessages", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of a chat to which the messages will be imported. It must be an identifier of a private chat with a mutual contact or an identifier of a supergroup chat with can_change_info administrator right" + }, + { + "name": "message_file", + "type": "InputFile", + "description": "File with messages to import. Only inputFileLocal and inputFileGenerated are supported. The file must not be previously uploaded" + }, + { + "name": "attached_files", + "type": "vector", + "description": "Files used in the imported messages. Only inputFileLocal and inputFileGenerated are supported. The files must not be previously uploaded" + } + ], + "description": "Imports messages exported from another app", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "replacePrimaryChatInviteLink", "methods": [ { "name": "chat_id", @@ -21543,19 +28258,259 @@ "description": "Chat identifier" } ], - "description": "Generates a new invite link for a chat; the previously generated link is revoked. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right", + "description": "Replaces current primary invite link for a chat with a new primary invite link. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right", "inheritance": "TLBaseClass", "return_type": "chatInviteLink", "isFunction": true, "isSynchronous": false }, + { + "name": "createChatInviteLink", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "name", + "type": "string", + "description": "Invite link name; 0-32 characters" + }, + { + "name": "expiration_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the link will expire; pass 0 if never" + }, + { + "name": "member_limit", + "type": "int32", + "description": "The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited" + }, + { + "name": "creates_join_request", + "type": "Bool", + "description": "Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0" + } + ], + "description": "Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLink", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "editChatInviteLink", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link to be edited" + }, + { + "name": "name", + "type": "string", + "description": "Invite link name; 0-32 characters" + }, + { + "name": "expiration_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the link will expire; pass 0 if never" + }, + { + "name": "member_limit", + "type": "int32", + "description": "The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited" + }, + { + "name": "creates_join_request", + "type": "Bool", + "description": "Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0" + } + ], + "description": "Edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLink", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getChatInviteLink", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link to get" + } + ], + "description": "Returns information about an invite link. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLink", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getChatInviteLinkCounts", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Returns list of chat administrators with number of their invite links. Requires owner privileges in the chat", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLinkCounts", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getChatInviteLinks", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "creator_user_id", + "type": "int53", + "description": "User identifier of a chat administrator. Must be an identifier of the current user for non-owner" + }, + { + "name": "is_revoked", + "type": "Bool", + "description": "Pass true if revoked links needs to be returned instead of active or expired" + }, + { + "name": "offset_date", + "type": "int32", + "description": "Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning" + }, + { + "name": "offset_invite_link", + "type": "string", + "description": "Invite link starting after which to return invite links; use empty string to get results from the beginning" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of invite links to return; up to 100" + } + ], + "description": "Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLinks", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getChatInviteLinkMembers", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link for which to return chat members" + }, + { + "name": "offset_member", + "type": "chatInviteLinkMember", + "description": "A chat member from which to return next chat members; pass null to get results from the beginning" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of chat members to return; up to 100" + } + ], + "description": "Returns chat members joined a chat via an invite link. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLinkMembers", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "revokeChatInviteLink", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link to be revoked" + } + ], + "description": "Revokes invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links. If a primary link is revoked, then additionally to the revoked link returns new primary link", + "inheritance": "TLBaseClass", + "return_type": "chatInviteLinks", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "deleteRevokedChatInviteLink", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link to revoke" + } + ], + "description": "Deletes revoked chat invite links. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "deleteAllRevokedChatInviteLinks", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "creator_user_id", + "type": "int53", + "description": "User identifier of a chat administrator, which links will be deleted. Must be an identifier of the current user for non-owner" + } + ], + "description": "Deletes all revoked chat invite links created by a given chat administrator. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "checkChatInviteLink", "methods": [ { "name": "invite_link", "type": "string", - "description": "Invite link to be checked; should begin with \"https://t.me/joinchat/\", \"https://telegram.me/joinchat/\", or \"https://telegram.dog/joinchat/\"" + "description": "Invite link to be checked" } ], "description": "Checks the validity of an invite link for a chat and returns information about the corresponding chat", @@ -21570,32 +28525,117 @@ { "name": "invite_link", "type": "string", - "description": "Invite link to import; should begin with \"https://t.me/joinchat/\", \"https://telegram.me/joinchat/\", or \"https://telegram.dog/joinchat/\"" + "description": "Invite link to use" } ], - "description": "Uses an invite link to add the current user to the chat if possible. The new member will not be added until the chat state has been synchronized with the server", + "description": "Uses an invite link to add the current user to the chat if possible. May return an error with a message \"INVITE_REQUEST_SENT\" if only a join request was created", "inheritance": "TLBaseClass", "return_type": "chat", "isFunction": true, "isSynchronous": false }, + { + "name": "getChatJoinRequests", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link for which to return join requests. If empty, all join requests will be returned. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links" + }, + { + "name": "query", + "type": "string", + "description": "A query to search for in the first names, last names and usernames of the users to return" + }, + { + "name": "offset_request", + "type": "chatJoinRequest", + "description": "A chat join request from which to return next requests; pass null to get results from the beginning" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of requests to join the chat to return" + } + ], + "description": "Returns pending join requests in a chat", + "inheritance": "TLBaseClass", + "return_type": "chatJoinRequests", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "processChatJoinRequest", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "user_id", + "type": "int53", + "description": "Identifier of the user that sent the request" + }, + { + "name": "approve", + "type": "Bool", + "description": "Pass true to approve the request; pass false to decline it" + } + ], + "description": "Handles a pending join request in a chat", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "processChatJoinRequests", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "invite_link", + "type": "string", + "description": "Invite link for which to process join requests. If empty, all join requests will be processed. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links" + }, + { + "name": "approve", + "type": "Bool", + "description": "Pass true to approve all requests; pass false to decline them" + } + ], + "description": "Handles all pending join requests for a given link in a chat", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "createCall", "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user to be called" }, { "name": "protocol", "type": "callProtocol", - "description": "Description of the call protocols supported by the application" + "description": "The call protocols supported by the application" }, { "name": "is_video", "type": "Bool", - "description": "True, if a video call needs to be created" + "description": "Pass true to create a video call" } ], "description": "Creates a new call", @@ -21615,7 +28655,7 @@ { "name": "protocol", "type": "callProtocol", - "description": "Description of the call protocols supported by the application" + "description": "The call protocols supported by the application" } ], "description": "Accepts an incoming call", @@ -21655,7 +28695,7 @@ { "name": "is_disconnected", "type": "Bool", - "description": "True, if the user was disconnected" + "description": "Pass true if the user was disconnected" }, { "name": "duration", @@ -21665,7 +28705,7 @@ { "name": "is_video", "type": "Bool", - "description": "True, if the call was a video call" + "description": "Pass true if the call was a video call" }, { "name": "connection_id", @@ -21723,14 +28763,684 @@ "description": "Debug information in application-specific format" } ], - "description": "Sends debug information for a call", + "description": "Sends debug information for a call to Telegram servers", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, "isSynchronous": false }, { - "name": "blockChatFromReplies", + "name": "sendCallLog", + "methods": [ + { + "name": "call_id", + "type": "int32", + "description": "Call identifier" + }, + { + "name": "log_file", + "type": "InputFile", + "description": "Call log file. Only inputFileLocal and inputFileGenerated are supported" + } + ], + "description": "Sends log file for a call to Telegram servers", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getVideoChatAvailableParticipants", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Returns list of participant identifiers, on whose behalf a video chat in the chat can be joined", + "inheritance": "TLBaseClass", + "return_type": "messageSenders", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setVideoChatDefaultParticipant", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "default_participant_id", + "type": "MessageSender", + "description": "Default group call participant identifier to join the video chats" + } + ], + "description": "Changes default participant identifier, on whose behalf a video chat in the chat will be joined", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "createVideoChat", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Identifier of a chat in which the video chat will be created" + }, + { + "name": "title", + "type": "string", + "description": "Group call title; if empty, chat title will be used" + }, + { + "name": "start_date", + "type": "int32", + "description": "Point in time (Unix timestamp) when the group call is supposed to be started by an administrator; 0 to start the video chat immediately. The date must be at least 10 seconds and at most 8 days in the future" + }, + { + "name": "is_rtmp_stream", + "type": "Bool", + "description": "Pass true to create an RTMP stream instead of an ordinary video chat; requires creator privileges" + } + ], + "description": "Creates a video chat (a group call bound to a chat). Available only for basic groups, supergroups and channels; requires can_manage_video_chats rights", + "inheritance": "TLBaseClass", + "return_type": "groupCallId", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getVideoChatRtmpUrl", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Returns RTMP URL for streaming to the chat; requires creator privileges", + "inheritance": "TLBaseClass", + "return_type": "rtmpUrl", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "replaceVideoChatRtmpUrl", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + } + ], + "description": "Replaces the current RTMP URL for streaming to the chat; requires creator privileges", + "inheritance": "TLBaseClass", + "return_type": "rtmpUrl", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getGroupCall", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Returns information about a group call", + "inheritance": "TLBaseClass", + "return_type": "groupCall", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "startScheduledGroupCall", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Starts a scheduled group call", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallEnabledStartNotification", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "enabled_start_notification", + "type": "Bool", + "description": "New value of the enabled_start_notification setting" + } + ], + "description": "Toggles whether the current user will receive a notification when the group call will start; scheduled group calls only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "joinGroupCall", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "participant_id", + "type": "MessageSender", + "description": "Identifier of a group call participant, which will be used to join the call; pass null to join as self; video chats only" + }, + { + "name": "audio_source_id", + "type": "int32", + "description": "Caller audio channel synchronization source identifier; received from tgcalls" + }, + { + "name": "payload", + "type": "string", + "description": "Group call join payload; received from tgcalls" + }, + { + "name": "is_muted", + "type": "Bool", + "description": "Pass true to join the call with muted microphone" + }, + { + "name": "is_my_video_enabled", + "type": "Bool", + "description": "Pass true if the user's video is enabled" + }, + { + "name": "invite_hash", + "type": "string", + "description": "If non-empty, invite hash to be used to join the group call without being muted by administrators" + } + ], + "description": "Joins an active group call. Returns join response payload for tgcalls", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "startGroupCallScreenSharing", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "audio_source_id", + "type": "int32", + "description": "Screen sharing audio channel synchronization source identifier; received from tgcalls" + }, + { + "name": "payload", + "type": "string", + "description": "Group call join payload; received from tgcalls" + } + ], + "description": "Starts screen sharing in a joined group call. Returns join response payload for tgcalls", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallScreenSharingIsPaused", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "is_paused", + "type": "Bool", + "description": "True if screen sharing is paused" + } + ], + "description": "Pauses or unpauses screen sharing in a joined group call", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "endGroupCallScreenSharing", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Ends screen sharing in a joined group call", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setGroupCallTitle", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "title", + "type": "string", + "description": "New group call title; 1-64 characters" + } + ], + "description": "Sets group call title. Requires groupCall.can_be_managed group call flag", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallMuteNewParticipants", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "mute_new_participants", + "type": "Bool", + "description": "New value of the mute_new_participants setting" + } + ], + "description": "Toggles whether new participants of a group call can be unmuted only by administrators of the group call. Requires groupCall.can_toggle_mute_new_participants group call flag", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "inviteGroupCallParticipants", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "user_ids", + "type": "vector", + "description": "User identifiers. At most 10 users can be invited simultaneously" + } + ], + "description": "Invites users to an active group call. Sends a service message of type messageInviteToGroupCall for video chats", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getGroupCallInviteLink", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "can_self_unmute", + "type": "Bool", + "description": "Pass true if the invite link needs to contain an invite hash, passing which to joinGroupCall would allow the invited user to unmute themselves. Requires groupCall.can_be_managed group call flag" + } + ], + "description": "Returns invite link to a video chat in a public chat", + "inheritance": "TLBaseClass", + "return_type": "httpUrl", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "revokeGroupCallInviteLink", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Revokes invite link for a group call. Requires groupCall.can_be_managed group call flag", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "startGroupCallRecording", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "title", + "type": "string", + "description": "Group call recording title; 0-64 characters" + }, + { + "name": "record_video", + "type": "Bool", + "description": "Pass true to record a video file instead of an audio file" + }, + { + "name": "use_portrait_orientation", + "type": "Bool", + "description": "Pass true to use portrait orientation for video instead of landscape one" + } + ], + "description": "Starts recording of an active group call. Requires groupCall.can_be_managed group call flag", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "endGroupCallRecording", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Ends recording of an active group call. Requires groupCall.can_be_managed group call flag", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallIsMyVideoPaused", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "is_my_video_paused", + "type": "Bool", + "description": "Pass true if the current user's video is paused" + } + ], + "description": "Toggles whether current user's video is paused", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallIsMyVideoEnabled", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "is_my_video_enabled", + "type": "Bool", + "description": "Pass true if the current user's video is enabled" + } + ], + "description": "Toggles whether current user's video is enabled", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setGroupCallParticipantIsSpeaking", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "audio_source", + "type": "int32", + "description": "Group call participant's synchronization audio source identifier, or 0 for the current user" + }, + { + "name": "is_speaking", + "type": "Bool", + "description": "Pass true if the user is speaking" + } + ], + "description": "Informs TDLib that speaking state of a participant of an active group has changed", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallParticipantIsMuted", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "participant_id", + "type": "MessageSender", + "description": "Participant identifier" + }, + { + "name": "is_muted", + "type": "Bool", + "description": "Pass true to mute the user; pass false to unmute the them" + } + ], + "description": "Toggles whether a participant of an active group call is muted, unmuted, or allowed to unmute themselves", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setGroupCallParticipantVolumeLevel", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "participant_id", + "type": "MessageSender", + "description": "Participant identifier" + }, + { + "name": "volume_level", + "type": "int32", + "description": "New participant's volume level; 1-20000 in hundreds of percents" + } + ], + "description": "Changes volume level of a participant of an active group call. If the current user can manage the group call, then the participant's volume level will be changed for all users with the default volume level", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleGroupCallParticipantIsHandRaised", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "participant_id", + "type": "MessageSender", + "description": "Participant identifier" + }, + { + "name": "is_hand_raised", + "type": "Bool", + "description": "Pass true if the user's hand needs to be raised. Only self hand can be raised. Requires groupCall.can_be_managed group call flag to lower other's hand" + } + ], + "description": "Toggles whether a group call participant hand is rased", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "loadGroupCallParticipants", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier. The group call must be previously received through getGroupCall and must be joined or being joined" + }, + { + "name": "limit", + "type": "int32", + "description": "The maximum number of participants to load; up to 100" + } + ], + "description": "Loads more participants of a group call. The loaded participants will be received through updates. Use the field groupCall.loaded_all_participants to check whether all participants have already been loaded", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "leaveGroupCall", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Leaves a group call", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "endGroupCall", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Ends a group call. Requires groupCall.can_be_managed", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getGroupCallStreams", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + } + ], + "description": "Returns information about available group call streams", + "inheritance": "TLBaseClass", + "return_type": "groupCallStreams", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getGroupCallStreamSegment", + "methods": [ + { + "name": "group_call_id", + "type": "int32", + "description": "Group call identifier" + }, + { + "name": "time_offset", + "type": "int53", + "description": "Point in time when the stream segment begins; Unix timestamp in milliseconds" + }, + { + "name": "scale", + "type": "int32", + "description": "Segment duration scale; 0-1. Segment's duration is 1000/(2**scale) milliseconds" + }, + { + "name": "channel_id", + "type": "int32", + "description": "Identifier of an audio/video channel to get as received from tgcalls" + }, + { + "name": "video_quality", + "type": "GroupCallVideoQuality", + "description": "Video quality as received from tgcalls; pass null to get the worst available quality" + } + ], + "description": "Returns a file with a segment of a group call stream in a modified OGG format for audio or MPEG-4 format for video", + "inheritance": "TLBaseClass", + "return_type": "filePart", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleMessageSenderIsBlocked", + "methods": [ + { + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of a message sender to block/unblock" + }, + { + "name": "is_blocked", + "type": "Bool", + "description": "New value of is_blocked" + } + ], + "description": "Changes the block state of a message sender. Currently, only users and supergroup chats can be blocked", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "blockMessageSenderFromReplies", "methods": [ { "name": "message_id", @@ -21740,17 +29450,17 @@ { "name": "delete_message", "type": "Bool", - "description": "Pass true if the message must be deleted" + "description": "Pass true to delete the message" }, { "name": "delete_all_messages", "type": "Bool", - "description": "Pass true if all messages from the same sender must be deleted" + "description": "Pass true to delete all messages from the same sender" }, { "name": "report_spam", "type": "Bool", - "description": "Pass true if the sender must be reported to the Telegram moderators" + "description": "Pass true to report the sender to the Telegram moderators" } ], "description": "Blocks an original sender of a message in the Replies chat", @@ -21760,22 +29470,22 @@ "isSynchronous": false }, { - "name": "getBlockedChats", + "name": "getBlockedMessageSenders", "methods": [ { "name": "offset", "type": "int32", - "description": "Number of chats to skip in the result; must be non-negative" + "description": "Number of users and chats to skip in the result; must be non-negative" }, { "name": "limit", "type": "int32", - "description": "The maximum number of chats to return; up to 100" + "description": "The maximum number of users and chats to return; up to 100" } ], - "description": "Returns chats that were blocked by the current user", + "description": "Returns users and chats that were blocked by the current user", "inheritance": "TLBaseClass", - "return_type": "chats", + "return_type": "messageSenders", "isFunction": true, "isSynchronous": false }, @@ -21785,12 +29495,12 @@ { "name": "contact", "type": "contact", - "description": "The contact to add or edit; phone number can be empty and needs to be specified only if known, vCard is ignored" + "description": "The contact to add or edit; phone number may be empty and needs to be specified only if known, vCard is ignored" }, { "name": "share_phone_number", "type": "Bool", - "description": "True, if the new contact needs to be allowed to see current user's phone number. A corresponding rule to userPrivacySettingShowPhoneNumber will be added if needed. Use the field UserFullInfo.need_phone_number_privacy_exception to check whether the current user needs to be asked to share their phone number" + "description": "Pass true to share the current user's phone number with the new contact. A corresponding rule to userPrivacySettingShowPhoneNumber will be added if needed. Use the field userFullInfo.need_phone_number_privacy_exception to check whether the current user needs to be asked to share their phone number" } ], "description": "Adds a user to the contact list or edits an existing contact by their user identifier", @@ -21848,7 +29558,7 @@ "methods": [ { "name": "user_ids", - "type": "vector", + "type": "vector", "description": "Identifiers of users to be deleted" } ], @@ -21876,7 +29586,7 @@ "description": "The new list of contacts, contact's vCard are ignored and are not imported" } ], - "description": "Changes imported contacts using the list of current user contacts saved on the device. Imports newly added contacts and, if at least the file database is enabled, deletes recently deleted contacts. Query result depends on the result of the previous query, so only one query is possible at the same time", + "description": "Changes imported contacts using the list of contacts saved on the device. Imports newly added contacts and, if at least the file database is enabled, deletes recently deleted contacts. Query result depends on the result of the previous query, so only one query is possible at the same time", "inheritance": "TLBaseClass", "return_type": "importedContacts", "isFunction": true, @@ -21891,12 +29601,27 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "searchUserByPhoneNumber", + "methods": [ + { + "name": "phone_number", + "type": "string", + "description": "Phone number to search for" + } + ], + "description": "Searches a user by their phone number. Returns a 404 error if the user can't be found", + "inheritance": "TLBaseClass", + "return_type": "user", + "isFunction": true, + "isSynchronous": false + }, { "name": "sharePhoneNumber", "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Identifier of the user with whom to share the phone number. The user must be a mutual contact" } ], @@ -21911,7 +29636,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -21934,6 +29659,11 @@ { "name": "getStickers", "methods": [ + { + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the sticker sets to return" + }, { "name": "emoji", "type": "string", @@ -21943,9 +29673,14 @@ "name": "limit", "type": "int32", "description": "The maximum number of stickers to be returned" + }, + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier for which to return stickers. Available custom emoji may be different for different chats" } ], - "description": "Returns stickers from the installed sticker sets that correspond to a given emoji. If the emoji is not empty, favorite and recently used stickers may also be returned", + "description": "Returns stickers from the installed sticker sets that correspond to a given emoji. If the emoji is non-empty, then favorite, recently used or trending stickers may also be returned", "inheritance": "TLBaseClass", "return_type": "stickers", "isFunction": true, @@ -21962,7 +29697,7 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of stickers to be returned" + "description": "The maximum number of stickers to be returned; 0-100" } ], "description": "Searches for stickers from public sticker sets that correspond to a given emoji", @@ -21971,13 +29706,28 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getPremiumStickers", + "methods": [ + { + "name": "limit", + "type": "int32", + "description": "The maximum number of stickers to be returned; 0-100" + } + ], + "description": "Returns premium stickers from regular sticker sets", + "inheritance": "TLBaseClass", + "return_type": "stickers", + "isFunction": true, + "isSynchronous": false + }, { "name": "getInstalledStickerSets", "methods": [ { - "name": "is_masks", - "type": "Bool", - "description": "Pass true to return mask sticker sets; pass false to return ordinary sticker sets" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the sticker sets to return" } ], "description": "Returns a list of installed sticker sets", @@ -21990,9 +29740,9 @@ "name": "getArchivedStickerSets", "methods": [ { - "name": "is_masks", - "type": "Bool", - "description": "Pass true to return mask stickers sets; pass false to return ordinary sticker sets" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the sticker sets to return" }, { "name": "offset_sticker_set_id", @@ -22002,7 +29752,7 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of sticker sets to return" + "description": "The maximum number of sticker sets to return; up to 100" } ], "description": "Returns a list of archived sticker sets", @@ -22014,6 +29764,11 @@ { "name": "getTrendingStickerSets", "methods": [ + { + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the sticker sets to return" + }, { "name": "offset", "type": "int32", @@ -22022,12 +29777,12 @@ { "name": "limit", "type": "int32", - "description": "The maximum number of sticker sets to be returned; must be non-negative. Fewer sticker sets may be returned than specified by the limit, even if the end of the list has not been reached" + "description": "The maximum number of sticker sets to be returned; up to 100. For optimal performance, the number of returned sticker sets is chosen by TDLib and can be smaller than the specified limit, even if the end of the list has not been reached" } ], - "description": "Returns a list of trending sticker sets. For the optimal performance the number of returned sticker sets is chosen by the library", + "description": "Returns a list of trending sticker sets. For optimal performance, the number of returned sticker sets is chosen by TDLib", "inheritance": "TLBaseClass", - "return_type": "stickerSets", + "return_type": "trendingStickerSets", "isFunction": true, "isSynchronous": false }, @@ -22040,7 +29795,7 @@ "description": "File identifier" } ], - "description": "Returns a list of sticker sets attached to a file. Currently only photos and videos can have attached sticker sets", + "description": "Returns a list of sticker sets attached to a file. Currently, only photos and videos can have attached sticker sets", "inheritance": "TLBaseClass", "return_type": "stickerSets", "isFunction": true, @@ -22080,9 +29835,9 @@ "name": "searchInstalledStickerSets", "methods": [ { - "name": "is_masks", - "type": "Bool", - "description": "Pass true to return mask sticker sets; pass false to return ordinary sticker sets" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the sticker sets to search for" }, { "name": "query", @@ -22160,9 +29915,9 @@ "name": "reorderInstalledStickerSets", "methods": [ { - "name": "is_masks", - "type": "Bool", - "description": "Pass true to change the order of mask sticker sets; pass false to change the order of ordinary sticker sets" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the sticker sets to reorder" }, { "name": "sticker_set_ids", @@ -22205,7 +29960,7 @@ "description": "Sticker file to add" } ], - "description": "Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list", + "description": "Manually adds a new sticker to the list of recently used stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list. Emoji stickers can't be added to recent stickers", "inheritance": "TLBaseClass", "return_type": "stickers", "isFunction": true, @@ -22264,7 +30019,7 @@ "description": "Sticker file to add" } ], - "description": "Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list", + "description": "Adds a new sticker to the list of favorite stickers. The new sticker is added to the top of the list. If the sticker was already in the list, it is removed from the list first. Only stickers belonging to a sticker set can be added to this list. Emoji stickers can't be added to favorite stickers", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -22311,7 +30066,7 @@ { "name": "exact_match", "type": "Bool", - "description": "True, if only emojis, which exactly match text needs to be returned" + "description": "Pass true if only emojis, which exactly match the text, needs to be returned" }, { "name": "input_language_codes", @@ -22325,6 +30080,21 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getAnimatedEmoji", + "methods": [ + { + "name": "emoji", + "type": "string", + "description": "The emoji" + } + ], + "description": "Returns an animated emoji corresponding to a given emoji. Returns a 404 error if the emoji has no animated emoji", + "inheritance": "TLBaseClass", + "return_type": "animatedEmoji", + "isFunction": true, + "isSynchronous": false + }, { "name": "getEmojiSuggestionsUrl", "methods": [ @@ -22340,6 +30110,21 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getCustomEmojiStickers", + "methods": [ + { + "name": "custom_emoji_ids", + "type": "vector", + "description": "Identifiers of custom emoji stickers. At most 200 custom emoji stickers can be received simultaneously" + } + ], + "description": "Returns list of custom emoji stickers by their identifiers. Stickers are returned in arbitrary order. Only found stickers are returned", + "inheritance": "TLBaseClass", + "return_type": "stickers", + "isFunction": true, + "isSynchronous": false + }, { "name": "getSavedAnimations", "methods": null, @@ -22355,7 +30140,7 @@ { "name": "animation", "type": "InputFile", - "description": "The animation file to be added. Only animations known to the server (i.e. successfully sent via a message) can be added to the list" + "description": "The animation file to be added. Only animations known to the server (i.e., successfully sent via a message) can be added to the list" } ], "description": "Manually adds a new animation to the list of saved animations. The new animation is added to the beginning of the list. If the animation was already in the list, it is removed first. Only non-secret video animations with MIME type \"video/mp4\" can be added to the list", @@ -22449,7 +30234,7 @@ { "name": "force_full", "type": "Bool", - "description": "If true, the full instant view for the web page will be returned" + "description": "Pass true to get full instant view for the web page" } ], "description": "Returns an instant view version of a web page if available. Returns a 404 error if the web page has no instant view page", @@ -22494,12 +30279,12 @@ { "name": "first_name", "type": "string", - "description": "The new value of the first name for the user; 1-64 characters" + "description": "The new value of the first name for the current user; 1-64 characters" }, { "name": "last_name", "type": "string", - "description": "The new value of the optional last name for the user; 0-64 characters" + "description": "The new value of the optional last name for the current user; 0-64 characters" } ], "description": "Changes the first and last name of the current user", @@ -22514,7 +30299,7 @@ { "name": "bio", "type": "string", - "description": "The new value of the user bio; 0-70 characters without line feeds" + "description": "The new value of the user bio; 0-GetOption(\"bio_length_max\") characters without line feeds" } ], "description": "Changes the bio of the current user", @@ -22538,6 +30323,26 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "setEmojiStatus", + "methods": [ + { + "name": "emoji_status", + "type": "emojiStatus", + "description": "New emoji status; pass null to switch to the default badge" + }, + { + "name": "duration", + "type": "int32", + "description": "Duration of the status, in seconds; pass 0 to keep the status active until it will be changed manually" + } + ], + "description": "Changes the emoji status of the current user; for Telegram Premium users only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "setLocation", "methods": [ @@ -22564,7 +30369,7 @@ { "name": "settings", "type": "phoneNumberAuthenticationSettings", - "description": "Settings for the authentication of the user's phone number" + "description": "Settings for the authentication of the user's phone number; pass null to use default settings" } ], "description": "Changes the phone number of the user and sends an authentication code to the user's new phone number. On success, returns information about the sent code", @@ -22576,7 +30381,7 @@ { "name": "resendChangePhoneNumberCode", "methods": null, - "description": "Re-sends the authentication code sent to confirm a new phone number for the user. Works only if the previously received authenticationCodeInfo next_code_type was not null", + "description": "Resends the authentication code sent to confirm a new phone number for the current user. Works only if the previously received authenticationCodeInfo next_code_type was not null and the server-specified timeout has passed", "inheritance": "TLBaseClass", "return_type": "authenticationCodeInfo", "isFunction": true, @@ -22588,7 +30393,7 @@ { "name": "code", "type": "string", - "description": "Verification code received by SMS, phone call or flash call" + "description": "Authentication code to check" } ], "description": "Checks the authentication code sent to confirm a new phone number of the user", @@ -22600,13 +30405,128 @@ { "name": "setCommands", "methods": [ + { + "name": "scope", + "type": "BotCommandScope", + "description": "The scope to which the commands are relevant; pass null to change commands in the default bot command scope" + }, + { + "name": "language_code", + "type": "string", + "description": "A two-letter ISO 639-1 language code. If empty, the commands will be applied to all users from the given scope, for which language there are no dedicated commands" + }, { "name": "commands", "type": "vector", "description": "List of the bot's commands" } ], - "description": "Sets the list of commands supported by the bot; for bots only", + "description": "Sets the list of commands supported by the bot for the given user scope and language; for bots only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "deleteCommands", + "methods": [ + { + "name": "scope", + "type": "BotCommandScope", + "description": "The scope to which the commands are relevant; pass null to delete commands in the default bot command scope" + }, + { + "name": "language_code", + "type": "string", + "description": "A two-letter ISO 639-1 language code or an empty string" + } + ], + "description": "Deletes commands supported by the bot for the given user scope and language; for bots only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getCommands", + "methods": [ + { + "name": "scope", + "type": "BotCommandScope", + "description": "The scope to which the commands are relevant; pass null to get commands in the default bot command scope" + }, + { + "name": "language_code", + "type": "string", + "description": "A two-letter ISO 639-1 language code or an empty string" + } + ], + "description": "Returns the list of commands supported by the bot for the given user scope and language; for bots only", + "inheritance": "TLBaseClass", + "return_type": "botCommands", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setMenuButton", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "Identifier of the user or 0 to set menu button for all users" + }, + { + "name": "menu_button", + "type": "botMenuButton", + "description": "New menu button" + } + ], + "description": "Sets menu button for the given user or for all users; for bots only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getMenuButton", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "Identifier of the user or 0 to get the default menu button" + } + ], + "description": "Returns menu button set by the bot for the given user; for bots only", + "inheritance": "TLBaseClass", + "return_type": "botMenuButton", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setDefaultGroupAdministratorRights", + "methods": [ + { + "name": "default_group_administrator_rights", + "type": "chatAdministratorRights", + "description": "Default administrator rights for adding the bot to basic group and supergroup chats; may be null" + } + ], + "description": "Sets default administrator rights for adding the bot to basic group and supergroup chats; for bots only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setDefaultChannelAdministratorRights", + "methods": [ + { + "name": "default_channel_administrator_rights", + "type": "chatAdministratorRights", + "description": "Default administrator rights for adding the bot to channels; may be null" + } + ], + "description": "Sets default administrator rights for adding the bot to channel chats; for bots only", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -22645,6 +30565,61 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "toggleSessionCanAcceptCalls", + "methods": [ + { + "name": "session_id", + "type": "int64", + "description": "Session identifier" + }, + { + "name": "can_accept_calls", + "type": "Bool", + "description": "Pass true to allow accepting incoming calls by the session; pass false otherwise" + } + ], + "description": "Toggles whether a session can accept incoming calls", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleSessionCanAcceptSecretChats", + "methods": [ + { + "name": "session_id", + "type": "int64", + "description": "Session identifier" + }, + { + "name": "can_accept_secret_chats", + "type": "Bool", + "description": "Pass true to allow accepring secret chats by the session; pass false otherwise" + } + ], + "description": "Toggles whether a session can accept incoming secret chats", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setInactiveSessionTtl", + "methods": [ + { + "name": "inactive_session_ttl_days", + "type": "int32", + "description": "New number of days of inactivity before sessions will be automatically terminated; 1-366 days" + } + ], + "description": "Changes the period of inactivity after which sessions will automatically be terminated", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "getConnectedWebsites", "methods": null, @@ -22683,7 +30658,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the supergroup or channel" }, { @@ -22703,7 +30678,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the supergroup" }, { @@ -22712,7 +30687,7 @@ "description": "New value of the supergroup sticker set identifier. Use 0 to remove the supergroup sticker set" } ], - "description": "Changes the sticker set of a supergroup; requires can_change_info rights", + "description": "Changes the sticker set of a supergroup; requires can_change_info administrator right", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -22723,7 +30698,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the channel" }, { @@ -22732,7 +30707,47 @@ "description": "New value of sign_messages" } ], - "description": "Toggles sender signatures messages sent in a channel; requires can_change_info rights", + "description": "Toggles whether sender signature is added to sent messages in a channel; requires can_change_info administrator right", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleSupergroupJoinToSendMessages", + "methods": [ + { + "name": "supergroup_id", + "type": "int53", + "description": "Identifier of the supergroup" + }, + { + "name": "join_to_send_messages", + "type": "Bool", + "description": "New value of join_to_send_messages" + } + ], + "description": "Toggles whether joining is mandatory to send messages to a discussion supergroup; requires can_restrict_members administrator right", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleSupergroupJoinByRequest", + "methods": [ + { + "name": "supergroup_id", + "type": "int53", + "description": "Identifier of the channel" + }, + { + "name": "join_by_request", + "type": "Bool", + "description": "New value of join_by_request" + } + ], + "description": "Toggles whether all users directly joining the supergroup need to be approved by supergroup administrators; requires can_restrict_members administrator right", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -22743,7 +30758,7 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "The identifier of the supergroup" }, { @@ -22752,7 +30767,22 @@ "description": "The new value of is_all_history_available" } ], - "description": "Toggles whether the message history of a supergroup is available to new members; requires can_change_info rights", + "description": "Toggles whether the message history of a supergroup is available to new members; requires can_change_info administrator right", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "toggleSupergroupIsBroadcastGroup", + "methods": [ + { + "name": "supergroup_id", + "type": "int53", + "description": "Identifier of the supergroup" + } + ], + "description": "Upgrades supergroup to a broadcast group; requires owner privileges in the supergroup", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -22763,21 +30793,16 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Supergroup identifier" }, - { - "name": "user_id", - "type": "int32", - "description": "User identifier" - }, { "name": "message_ids", "type": "vector", - "description": "Identifiers of messages sent in the supergroup by the user. This list must be non-empty" + "description": "Identifiers of messages to report" } ], - "description": "Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup", + "description": "Reports messages in a supergroup as spam; requires administrator rights in the supergroup", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -22788,13 +30813,13 @@ "methods": [ { "name": "supergroup_id", - "type": "int32", + "type": "int53", "description": "Identifier of the supergroup or channel" }, { "name": "filter", "type": "SupergroupMembersFilter", - "description": "The type of users to return. By default, supergroupMembersRecent" + "description": "The type of users to return; pass null to use supergroupMembersFilterRecent" }, { "name": "offset", @@ -22807,27 +30832,12 @@ "description": "The maximum number of users be returned; up to 200" } ], - "description": "Returns information about members or banned users in a supergroup or channel. Can be used only if SupergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters", + "description": "Returns information about members or banned users in a supergroup or channel. Can be used only if supergroupFullInfo.can_get_members == true; additionally, administrator privileges may be required for some filters", "inheritance": "TLBaseClass", "return_type": "chatMembers", "isFunction": true, "isSynchronous": false }, - { - "name": "deleteSupergroup", - "methods": [ - { - "name": "supergroup_id", - "type": "int32", - "description": "Identifier of the supergroup or channel" - } - ], - "description": "Deletes a supergroup or channel along with all messages in the corresponding chat. This will release the supergroup or channel username and remove all members; requires owner privileges in the supergroup or channel. Chats with more than 1000 members can't be deleted using this method", - "inheritance": "TLBaseClass", - "return_type": "ok", - "isFunction": true, - "isSynchronous": false - }, { "name": "closeSecretChat", "methods": [ @@ -22869,15 +30879,15 @@ { "name": "filters", "type": "chatEventLogFilters", - "description": "The types of events to return. By default, all types will be returned" + "description": "The types of events to return; pass null to get chat events of all types" }, { "name": "user_ids", - "type": "vector", + "type": "vector", "description": "User identifiers by which to filter events. By default, events relating to all users will be returned" } ], - "description": "Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only for supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i. e., in order of decreasing event_id)", + "description": "Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only for supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i.e., in order of decreasing event_id)", "inheritance": "TLBaseClass", "return_type": "chatEvents", "isFunction": true, @@ -22887,17 +30897,17 @@ "name": "getPaymentForm", "methods": [ { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier of the Invoice message" + "name": "input_invoice", + "type": "InputInvoice", + "description": "The invoice" }, { - "name": "message_id", - "type": "int53", - "description": "Message identifier" + "name": "theme", + "type": "themeParameters", + "description": "Preferred payment form theme; pass null to use the default theme" } ], - "description": "Returns an invoice payment form. This method should be called when the user presses inlineKeyboardButtonBuy", + "description": "Returns an invoice payment form. This method must be called when the user presses inlineKeyboardButtonBuy", "inheritance": "TLBaseClass", "return_type": "paymentForm", "isFunction": true, @@ -22907,24 +30917,19 @@ "name": "validateOrderInfo", "methods": [ { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier of the Invoice message" - }, - { - "name": "message_id", - "type": "int53", - "description": "Message identifier" + "name": "input_invoice", + "type": "InputInvoice", + "description": "The invoice" }, { "name": "order_info", "type": "orderInfo", - "description": "The order information, provided by the user" + "description": "The order information, provided by the user; pass null if empty" }, { "name": "allow_save", "type": "Bool", - "description": "True, if the order information can be saved" + "description": "Pass true to save the order information" } ], "description": "Validates the order information provided by a user and returns the available shipping options for a flexible invoice", @@ -22937,19 +30942,19 @@ "name": "sendPaymentForm", "methods": [ { - "name": "chat_id", - "type": "int53", - "description": "Chat identifier of the Invoice message" + "name": "input_invoice", + "type": "InputInvoice", + "description": "The invoice" }, { - "name": "message_id", - "type": "int53", - "description": "Message identifier" + "name": "payment_form_id", + "type": "int64", + "description": "Payment form identifier returned by getPaymentForm" }, { "name": "order_info_id", "type": "string", - "description": "Identifier returned by ValidateOrderInfo, or an empty string" + "description": "Identifier returned by validateOrderInfo, or an empty string" }, { "name": "shipping_option_id", @@ -22960,6 +30965,11 @@ "name": "credentials", "type": "InputCredentials", "description": "The credentials chosen by user for payment" + }, + { + "name": "tip_amount", + "type": "int53", + "description": "Chosen by the user amount of tip in the smallest units of the currency" } ], "description": "Sends a filled-out payment form to the bot for final verification", @@ -22991,7 +31001,7 @@ { "name": "getSavedOrderInfo", "methods": null, - "description": "Returns saved order info, if any", + "description": "Returns saved order information. Returns a 404 error if there is no saved order information", "inheritance": "TLBaseClass", "return_type": "orderInfo", "isFunction": true, @@ -23000,7 +31010,7 @@ { "name": "deleteSavedOrderInfo", "methods": null, - "description": "Deletes saved order info", + "description": "Deletes saved order information", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -23015,6 +31025,21 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "createInvoiceLink", + "methods": [ + { + "name": "invoice", + "type": "InputMessageContent", + "description": "Information about the invoice of the type inputMessageInvoice" + } + ], + "description": "Creates a link for the given invoice; for bots only", + "inheritance": "TLBaseClass", + "return_type": "httpUrl", + "isFunction": true, + "isSynchronous": false + }, { "name": "getSupportUser", "methods": null, @@ -23030,7 +31055,7 @@ { "name": "for_dark_theme", "type": "Bool", - "description": "True, if the backgrounds need to be ordered for dark theme" + "description": "Pass true to order returned backgrounds for a dark theme" } ], "description": "Returns backgrounds installed by the user", @@ -23080,17 +31105,17 @@ { "name": "background", "type": "InputBackground", - "description": "The input background to use, null for filled backgrounds" + "description": "The input background to use; pass null to create a new filled backgrounds or to remove the current background" }, { "name": "type", "type": "BackgroundType", - "description": "Background type; null for default background. The method will return error 404 if type is null" + "description": "Background type; pass null to use the default type of the remote background or to remove the current background" }, { "name": "for_dark_theme", "type": "Bool", - "description": "True, if the background is chosen for dark theme" + "description": "Pass true if the background is changed for a dark theme" } ], "description": "Changes the background selected by the user; adds background to the list of installed backgrounds", @@ -23129,7 +31154,7 @@ { "name": "only_local", "type": "Bool", - "description": "If true, returns only locally available information without sending network requests" + "description": "Pass true to get only locally available information without sending network requests" } ], "description": "Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization", @@ -23283,7 +31308,7 @@ }, { "name": "other_user_ids", - "type": "vector", + "type": "vector", "description": "List of user identifiers of other users currently using the application" } ], @@ -23382,11 +31407,11 @@ "description": "The name of the option" } ], - "description": "Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization", + "description": "Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization. Can be called synchronously for options \"version\" and \"commit_hash\"", "inheritance": "TLBaseClass", "return_type": "OptionValue", "isFunction": true, - "isSynchronous": false + "isSynchronous": true }, { "name": "setOption", @@ -23399,7 +31424,7 @@ { "name": "value", "type": "OptionValue", - "description": "The new value of the option" + "description": "The new value of the option; pass null to reset option value to a default value" } ], "description": "Sets the value of an option. (Check the list of available options on https://core.telegram.org/tdlib/options.) Only writable options can be set. Can be called before authorization", @@ -23439,6 +31464,11 @@ "name": "reason", "type": "string", "description": "The reason why the account was deleted; optional" + }, + { + "name": "password", + "type": "string", + "description": "The 2-step verification password of the current user. If not specified, account deletion can be canceled within one week" } ], "description": "Deletes the account of the current user, deleting all information associated with the user from the server. The phone number of the account can be used to create a new account. Can be called before authorization when the current authorization state is authorizationStateWaitPassword", @@ -23470,25 +31500,30 @@ "type": "int53", "description": "Chat identifier" }, + { + "name": "message_ids", + "type": "vector", + "description": "Identifiers of reported messages; may be empty to report the whole chat" + }, { "name": "reason", "type": "ChatReportReason", "description": "The reason for reporting the chat" }, { - "name": "message_ids", - "type": "vector", - "description": "Identifiers of reported messages, if any" + "name": "text", + "type": "string", + "description": "Additional report details; 0-1024 characters" } ], - "description": "Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, or if this is a private chats with a bot, a private chat with a user sharing their location, a supergroup, or a channel, since other chats can't be checked by moderators", + "description": "Reports a chat to the Telegram moderators. A chat can be reported only from the chat action bar, or if chat.can_be_reported", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, "isSynchronous": false }, { - "name": "getChatStatisticsUrl", + "name": "reportChatPhoto", "methods": [ { "name": "chat_id", @@ -23496,19 +31531,49 @@ "description": "Chat identifier" }, { - "name": "parameters", - "type": "string", - "description": "Parameters from \"tg://statsrefresh?params=******\" link" + "name": "file_id", + "type": "int32", + "description": "Identifier of the photo to report. Only full photos from chatPhoto can be reported" }, { - "name": "is_dark", - "type": "Bool", - "description": "Pass true if a URL with the dark theme must be returned" + "name": "reason", + "type": "ChatReportReason", + "description": "The reason for reporting the chat photo" + }, + { + "name": "text", + "type": "string", + "description": "Additional report details; 0-1024 characters" } ], - "description": "Returns an HTTP URL with the chat statistics. Currently this method of getting the statistics are disabled and can be deleted in the future", + "description": "Reports a chat photo to the Telegram moderators. A chat photo can be reported only if chat.can_be_reported", "inheritance": "TLBaseClass", - "return_type": "httpUrl", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "reportMessageReactions", + "methods": [ + { + "name": "chat_id", + "type": "int53", + "description": "Chat identifier" + }, + { + "name": "message_id", + "type": "int53", + "description": "Message identifier" + }, + { + "name": "sender_id", + "type": "MessageSender", + "description": "Identifier of the sender, which added the reaction" + } + ], + "description": "Reports reactions set on a message to the Telegram moderators. Reactions on a message can be reported only if message.can_report_reactions", + "inheritance": "TLBaseClass", + "return_type": "ok", "isFunction": true, "isSynchronous": false }, @@ -23526,7 +31591,7 @@ "description": "Pass true if a dark theme is used by the application" } ], - "description": "Returns detailed statistics about a chat. Currently this method can be used only for supergroups and channels. Can be used only if SupergroupFullInfo.can_get_statistics == true", + "description": "Returns detailed statistics about a chat. Currently, this method can be used only for supergroups and channels. Can be used only if supergroupFullInfo.can_get_statistics == true", "inheritance": "TLBaseClass", "return_type": "ChatStatistics", "isFunction": true, @@ -23551,14 +31616,14 @@ "description": "Pass true if a dark theme is used by the application" } ], - "description": "Returns detailed statistics about a message. Can be used only if Message.can_get_statistics == true", + "description": "Returns detailed statistics about a message. Can be used only if message.can_get_statistics == true", "inheritance": "TLBaseClass", "return_type": "messageStatistics", "isFunction": true, "isSynchronous": false }, { - "name": "getStatisticsGraph", + "name": "getStatisticalGraph", "methods": [ { "name": "chat_id", @@ -23576,9 +31641,9 @@ "description": "X-value for zoomed in graph or 0 otherwise" } ], - "description": "Loads asynchronous or zoomed in chat or message statistics graph", + "description": "Loads an asynchronous or a zoomed in statistical graph", "inheritance": "TLBaseClass", - "return_type": "StatisticsGraph", + "return_type": "StatisticalGraph", "isFunction": true, "isSynchronous": false }, @@ -23588,7 +31653,7 @@ { "name": "chat_limit", "type": "int32", - "description": "The maximum number of chats with the largest storage usage for which separate statistics should be returned. All other chats will be grouped in entries with chat_id == 0. If the chat info database is not used, the chat_limit is ignored and is always set to 0" + "description": "The maximum number of chats with the largest storage usage for which separate statistics need to be returned. All other chats will be grouped in entries with chat_id == 0. If the chat info database is not used, the chat_limit is ignored and is always set to 0" } ], "description": "Returns storage usage statistics. Can be called before authorization", @@ -23621,7 +31686,7 @@ { "name": "size", "type": "int53", - "description": "Limit on the total size of files after deletion. Pass -1 to use the default limit" + "description": "Limit on the total size of files after deletion, in bytes. Pass -1 to use the default limit" }, { "name": "ttl", @@ -23631,7 +31696,7 @@ { "name": "count", "type": "int32", - "description": "Limit on the total count of files after deletion. Pass -1 to use the default limit" + "description": "Limit on the total number of files after deletion. Pass -1 to use the default limit" }, { "name": "immunity_delay", @@ -23641,22 +31706,22 @@ { "name": "file_types", "type": "vector", - "description": "If not empty, only files with the given type(s) are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted" + "description": "If non-empty, only files with the given types are considered. By default, all types except thumbnails, profile photos, stickers and wallpapers are deleted" }, { "name": "chat_ids", "type": "vector", - "description": "If not empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos)" + "description": "If non-empty, only files from the given chats are considered. Use 0 as chat identifier to delete files not belonging to any chat (e.g., profile photos)" }, { "name": "exclude_chat_ids", "type": "vector", - "description": "If not empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos)" + "description": "If non-empty, files from the given chats are excluded. Use 0 as chat identifier to exclude all files not belonging to any chat (e.g., profile photos)" }, { "name": "return_deleted_file_statistics", "type": "Bool", - "description": "Pass true if deleted file statistics need to be returned instead of the whole storage usage statistics. Affects only returned statistics" + "description": "Pass true if statistics about the files that were deleted must be returned instead of the whole storage usage statistics. Affects only returned statistics" }, { "name": "chat_limit", @@ -23676,10 +31741,10 @@ { "name": "type", "type": "NetworkType", - "description": "The new network type. By default, networkTypeOther" + "description": "The new network type; pass null to set network type to networkTypeOther" } ], - "description": "Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it should be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics", + "description": "Sets the current network type. Can be called before authorization. Calling this method forces all network connections to reopen, mitigating the delay in switching between different networks, so it must be called whenever the network is changed, even if the network type remains the same. Network type is used to check whether the library can use the network at all and also for collecting detailed network data usage statistics", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -23691,7 +31756,7 @@ { "name": "only_current", "type": "Bool", - "description": "If true, returns only data for the current library launch" + "description": "Pass true to get statistics only for the current library launch" } ], "description": "Returns network data usage statistics. Can be called before authorization", @@ -23744,7 +31809,7 @@ { "name": "type", "type": "NetworkType", - "description": "Type of the network for which the new settings are applied" + "description": "Type of the network for which the new settings are relevant" } ], "description": "Sets auto-download settings", @@ -23779,7 +31844,7 @@ { "name": "password", "type": "string", - "description": "Password of the current user" + "description": "The 2-step verification password of the current user" } ], "description": "Returns one of the available Telegram Passport elements", @@ -23794,7 +31859,7 @@ { "name": "password", "type": "string", - "description": "Password of the current user" + "description": "The 2-step verification password of the current user" } ], "description": "Returns all available Telegram Passport elements", @@ -23814,7 +31879,7 @@ { "name": "password", "type": "string", - "description": "Password of the current user" + "description": "The 2-step verification password of the current user" } ], "description": "Adds an element to the user's Telegram Passport. May return an error with a message \"PHONE_VERIFICATION_NEEDED\" or \"EMAIL_VERIFICATION_NEEDED\" if the chosen phone number or the chosen email address must be verified first", @@ -23843,7 +31908,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "User identifier" }, { @@ -23867,7 +31932,7 @@ "description": "A two-letter ISO 3166-1 alpha-2 country code" } ], - "description": "Returns an IETF language tag of the language preferred in the country, which should be used to fill native fields in Telegram Passport personal details. Returns a 404 error if unknown", + "description": "Returns an IETF language tag of the language preferred in the country, which must be used to fill native fields in Telegram Passport personal details. Returns a 404 error if unknown", "inheritance": "TLBaseClass", "return_type": "text", "isFunction": true, @@ -23884,7 +31949,7 @@ { "name": "settings", "type": "phoneNumberAuthenticationSettings", - "description": "Settings for the authentication of the user's phone number" + "description": "Settings for the authentication of the user's phone number; pass null to use default settings" } ], "description": "Sends a code to verify a phone number to be added to a user's Telegram Passport", @@ -23896,7 +31961,7 @@ { "name": "resendPhoneNumberVerificationCode", "methods": null, - "description": "Re-sends the code to verify a phone number to be added to a user's Telegram Passport", + "description": "Resends the code to verify a phone number to be added to a user's Telegram Passport", "inheritance": "TLBaseClass", "return_type": "authenticationCodeInfo", "isFunction": true, @@ -23908,7 +31973,7 @@ { "name": "code", "type": "string", - "description": "Verification code" + "description": "Verification code to check" } ], "description": "Checks the phone number verification code for Telegram Passport", @@ -23935,7 +32000,7 @@ { "name": "resendEmailAddressVerificationCode", "methods": null, - "description": "Re-sends the code to verify an email address to be added to a user's Telegram Passport", + "description": "Resends the code to verify an email address to be added to a user's Telegram Passport", "inheritance": "TLBaseClass", "return_type": "emailAddressAuthenticationCodeInfo", "isFunction": true, @@ -23947,7 +32012,7 @@ { "name": "code", "type": "string", - "description": "Verification code" + "description": "Verification code to check" } ], "description": "Checks the email address verification code for Telegram Passport", @@ -23961,7 +32026,7 @@ "methods": [ { "name": "bot_user_id", - "type": "int32", + "type": "int53", "description": "User identifier of the service's bot" }, { @@ -23972,12 +32037,12 @@ { "name": "public_key", "type": "string", - "description": "Service's public_key" + "description": "Service's public key" }, { "name": "nonce", "type": "string", - "description": "Authorization form nonce provided by the service" + "description": "Unique request identifier provided by the service" } ], "description": "Returns a Telegram Passport authorization form for sharing data with a service", @@ -23997,7 +32062,7 @@ { "name": "password", "type": "string", - "description": "Password of the current user" + "description": "The 2-step verification password of the current user" } ], "description": "Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form", @@ -24020,7 +32085,7 @@ "description": "Types of Telegram Passport elements chosen by user to complete the authorization form" } ], - "description": "Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements need to be used", + "description": "Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after getPassportAuthorizationFormAvailableElements if some previously available elements are going to be reused", "inheritance": "TLBaseClass", "return_type": "ok", "isFunction": true, @@ -24032,20 +32097,20 @@ { "name": "hash", "type": "string", - "description": "Value of the \"hash\" parameter from the link" + "description": "Hash value from the link" }, { "name": "phone_number", "type": "string", - "description": "Value of the \"phone\" parameter from the link" + "description": "Phone number value from the link" }, { "name": "settings", "type": "phoneNumberAuthenticationSettings", - "description": "Settings for the authentication of the user's phone number" + "description": "Settings for the authentication of the user's phone number; pass null to use default settings" } ], - "description": "Sends phone number confirmation code. Should be called when user presses \"https://t.me/confirmphone?phone=*******&hash=**********\" or \"tg://confirmphone?phone=*******&hash=**********\" link", + "description": "Sends phone number confirmation code to handle links of the type internalLinkTypePhoneNumberConfirmation", "inheritance": "TLBaseClass", "return_type": "authenticationCodeInfo", "isFunction": true, @@ -24066,7 +32131,7 @@ { "name": "code", "type": "string", - "description": "The phone number confirmation code" + "description": "Confirmation code to check" } ], "description": "Checks phone number confirmation code", @@ -24100,28 +32165,58 @@ "methods": [ { "name": "user_id", - "type": "int32", - "description": "Sticker file owner" + "type": "int53", + "description": "Sticker file owner; ignored for regular users" }, { - "name": "png_sticker", - "type": "InputFile", - "description": "PNG image with the sticker; must be up to 512 KB in size and fit in 512x512 square" + "name": "sticker", + "type": "inputSticker", + "description": "Sticker file to upload" } ], - "description": "Uploads a PNG image with a sticker; for bots only; returns the uploaded file", + "description": "Uploads a file with a sticker; returns the uploaded file", "inheritance": "TLBaseClass", "return_type": "file", "isFunction": true, "isSynchronous": false }, + { + "name": "getSuggestedStickerSetName", + "methods": [ + { + "name": "title", + "type": "string", + "description": "Sticker set title; 1-64 characters" + } + ], + "description": "Returns a suggested name for a new sticker set with a given title", + "inheritance": "TLBaseClass", + "return_type": "text", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "checkStickerSetName", + "methods": [ + { + "name": "name", + "type": "string", + "description": "Name to be checked" + } + ], + "description": "Checks whether a name can be used for a new sticker set", + "inheritance": "TLBaseClass", + "return_type": "CheckStickerSetNameResult", + "isFunction": true, + "isSynchronous": false + }, { "name": "createNewStickerSet", "methods": [ { "name": "user_id", - "type": "int32", - "description": "Sticker set owner" + "type": "int53", + "description": "Sticker set owner; ignored for regular users" }, { "name": "title", @@ -24131,20 +32226,25 @@ { "name": "name", "type": "string", - "description": "Sticker set name. Can contain only English letters, digits and underscores. Must end with *\"_by_\"* (** is case insensitive); 1-64 characters" + "description": "Sticker set name. Can contain only English letters, digits and underscores. Must end with *\"_by_\"* (** is case insensitive) for bots; 1-64 characters" }, { - "name": "is_masks", - "type": "Bool", - "description": "True, if stickers are masks. Animated stickers can't be masks" + "name": "sticker_type", + "type": "StickerType", + "description": "Type of the stickers in the set" }, { "name": "stickers", - "type": "vector", - "description": "List of stickers to be added to the set; must be non-empty. All stickers must be of the same type" + "type": "vector", + "description": "List of stickers to be added to the set; must be non-empty. All stickers must have the same format. For TGS stickers, uploadStickerFile must be used before the sticker is shown" + }, + { + "name": "source", + "type": "string", + "description": "Source of the sticker set; may be empty if unknown" } ], - "description": "Creates a new sticker set; for bots only. Returns the newly created sticker set", + "description": "Creates a new sticker set. Returns the newly created sticker set", "inheritance": "TLBaseClass", "return_type": "stickerSet", "isFunction": true, @@ -24155,7 +32255,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Sticker set owner" }, { @@ -24165,7 +32265,7 @@ }, { "name": "sticker", - "type": "InputSticker", + "type": "inputSticker", "description": "Sticker to add to the set" } ], @@ -24180,7 +32280,7 @@ "methods": [ { "name": "user_id", - "type": "int32", + "type": "int53", "description": "Sticker set owner" }, { @@ -24191,7 +32291,7 @@ { "name": "thumbnail", "type": "InputFile", - "description": "Thumbnail to set in PNG or TGS format. Animated thumbnail must be set for animated sticker sets and only for them. Pass a zero InputFileId to delete the thumbnail" + "description": "Thumbnail to set in PNG, TGS, or WEBM format; pass null to remove the sticker set thumbnail. Thumbnail format must match the format of stickers in the set" } ], "description": "Sets a sticker set thumbnail; for bots only. Returns the sticker set", @@ -24211,7 +32311,7 @@ { "name": "position", "type": "int32", - "description": "New position of the sticker in the set, zero-based" + "description": "New position of the sticker in the set, 0-based" } ], "description": "Changes the position of a sticker in the set to which it belongs; for bots only. The sticker set must have been created by the bot", @@ -24266,7 +32366,7 @@ { "name": "chat_id", "type": "int53", - "description": "Identifier of a chat, in which the thumbnail will be shown. Use 0 if unknown" + "description": "Identifier of a chat in which the thumbnail will be shown. Use 0 if unknown" } ], "description": "Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded", @@ -24275,6 +32375,143 @@ "isFunction": true, "isSynchronous": false }, + { + "name": "getPremiumLimit", + "methods": [ + { + "name": "limit_type", + "type": "PremiumLimitType", + "description": "Type of the limit" + } + ], + "description": "Returns information about a limit, increased for Premium users. Returns a 404 error if the limit is unknown", + "inheritance": "TLBaseClass", + "return_type": "premiumLimit", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getPremiumFeatures", + "methods": [ + { + "name": "source", + "type": "PremiumSource", + "description": "Source of the request; pass null if the method is called from some non-standard source" + } + ], + "description": "Returns information about features, available to Premium users", + "inheritance": "TLBaseClass", + "return_type": "premiumFeatures", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getPremiumStickerExamples", + "methods": null, + "description": "Returns examples of premium stickers for demonstration purposes", + "inheritance": "TLBaseClass", + "return_type": "stickers", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "viewPremiumFeature", + "methods": [ + { + "name": "feature", + "type": "PremiumFeature", + "description": "The viewed premium feature" + } + ], + "description": "Informs TDLib that the user viewed detailed information about a Premium feature on the Premium features screen", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "clickPremiumSubscriptionButton", + "methods": null, + "description": "Informs TDLib that the user clicked Premium subscription button on the Premium features screen", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "getPremiumState", + "methods": null, + "description": "Returns state of Telegram Premium subscription and promotion videos for Premium features", + "inheritance": "TLBaseClass", + "return_type": "premiumState", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "canPurchasePremium", + "methods": [ + { + "name": "purpose", + "type": "StorePaymentPurpose", + "description": "Transaction purpose" + } + ], + "description": "Checks whether Telegram Premium purchase is possible. Must be called before in-store Premium purchase", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "assignAppStoreTransaction", + "methods": [ + { + "name": "receipt", + "type": "bytes", + "description": "App Store receipt" + }, + { + "name": "purpose", + "type": "StorePaymentPurpose", + "description": "Transaction purpose" + } + ], + "description": "Informs server about a purchase through App Store. For official applications only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "assignGooglePlayTransaction", + "methods": [ + { + "name": "package_name", + "type": "string", + "description": "Application package name" + }, + { + "name": "store_product_id", + "type": "string", + "description": "Identifier of the purchased store product" + }, + { + "name": "purchase_token", + "type": "string", + "description": "Google Play purchase token" + }, + { + "name": "purpose", + "type": "StorePaymentPurpose", + "description": "Transaction purpose" + } + ], + "description": "Informs server about a purchase through Google Play. For official applications only", + "inheritance": "TLBaseClass", + "return_type": "ok", + "isFunction": true, + "isSynchronous": false + }, { "name": "acceptTermsOfService", "methods": [ @@ -24357,7 +32594,7 @@ { "name": "getCountryCode", "methods": null, - "description": "Uses current user IP address to find their country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization", + "description": "Uses the current IP address to find the current country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization", "inheritance": "TLBaseClass", "return_type": "text", "isFunction": true, @@ -24379,11 +32616,31 @@ "isSynchronous": false }, { - "name": "getInviteText", - "methods": null, - "description": "Returns the default text for invitation messages to be used as a placeholder when the current user invites friends to Telegram", + "name": "getPhoneNumberInfoSync", + "methods": [ + { + "name": "language_code", + "type": "string", + "description": "A two-letter ISO 639-1 language code for country information localization" + }, + { + "name": "phone_number_prefix", + "type": "string", + "description": "The phone number prefix" + } + ], + "description": "Returns information about a phone number by its prefix synchronously. getCountries must be called at least once after changing localization to the specified language if properly localized country information is expected. Can be called synchronously", "inheritance": "TLBaseClass", - "return_type": "text", + "return_type": "phoneNumberInfo", + "isFunction": true, + "isSynchronous": true + }, + { + "name": "getApplicationDownloadLink", + "methods": null, + "description": "Returns the link for downloading official Telegram application to be used when the current user invites friends to Telegram", + "inheritance": "TLBaseClass", + "return_type": "httpUrl", "isFunction": true, "isSynchronous": false }, @@ -24452,7 +32709,7 @@ { "name": "enable", "type": "Bool", - "description": "True, if the proxy should be enabled" + "description": "Pass true to immediately enable the proxy" }, { "name": "type", @@ -24487,7 +32744,7 @@ { "name": "enable", "type": "Bool", - "description": "True, if the proxy should be enabled" + "description": "Pass true to immediately enable the proxy" }, { "name": "type", @@ -24560,7 +32817,7 @@ ], "description": "Returns an HTTPS link, which can be used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization", "inheritance": "TLBaseClass", - "return_type": "text", + "return_type": "httpUrl", "isFunction": true, "isSynchronous": false }, @@ -24677,7 +32934,7 @@ { "name": "verbosity_level", "type": "int32", - "description": "The minimum verbosity level needed for the message to be logged, 0-1023" + "description": "The minimum verbosity level needed for the message to be logged; 0-1023" }, { "name": "text", @@ -24691,6 +32948,41 @@ "isFunction": true, "isSynchronous": true }, + { + "name": "getUserSupportInfo", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "User identifier" + } + ], + "description": "Returns support information for the given user; for Telegram support only", + "inheritance": "TLBaseClass", + "return_type": "userSupportInfo", + "isFunction": true, + "isSynchronous": false + }, + { + "name": "setUserSupportInfo", + "methods": [ + { + "name": "user_id", + "type": "int53", + "description": "User identifier" + }, + { + "name": "message", + "type": "formattedText", + "description": "New information message" + } + ], + "description": "Sets support information for the given user; for Telegram support only", + "inheritance": "TLBaseClass", + "return_type": "userSupportInfo", + "isFunction": true, + "isSynchronous": false + }, { "name": "testCallEmpty", "methods": null, @@ -24835,7 +33127,7 @@ { "name": "dc_id", "type": "int32", - "description": "Identifier of a datacenter, with which to test connection" + "description": "Identifier of a datacenter with which to test connection" }, { "name": "timeout", @@ -24882,4 +33174,15 @@ "isFunction": true, "isSynchronous": true } -] \ No newline at end of file +] +---------- +LICENSE: +Copyright 2019 Ernesto Castellotti +This Source Code Form is subject to the terms of the Mozilla Public +License, v. 2.0. If a copy of the MPL was not distributed with this +file, You can obtain one at https://mozilla.org/MPL/2.0/. + +Appendix by copyright onwer: +All files or characters displayed on the screen generated by this program +are to be considered as the property of the copyright owner, any use (including commercial) +is permitted on the condition of publicly mentioning the use of this software.