[−][src]Module rtdlib::types
Structs
| AcceptCall | Accepts an incoming call |
| AcceptTermsOfService | Accepts Telegram terms of services |
| AccountTtl | Contains information about the period of inactivity after which the current user's account will automatically be deleted |
| AddChatMember | 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 |
| AddChatMembers | 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 |
| AddContact | Adds a user to the contact list or edits an existing contact by their user identifier |
| AddCustomServerLanguagePack | Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization |
| AddFavoriteSticker | 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 |
| AddLocalMessage | Adds a local message to a chat. The message is persistent across application restarts only if the message database is used. Returns the added message |
| AddLogMessage | Adds a message to TDLib internal log. This is an offline method. Can be called before authorization. Can be called synchronously |
| AddNetworkStatistics | Adds the specified data to data usage statistics. Can be called before authorization |
| AddProxy | Adds a proxy server for network requests. Can be called before authorization |
| AddRecentSticker | 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 |
| AddRecentlyFoundChat | Adds a chat to the list of recently found chats. The chat is added to the beginning of the list. If the chat is already in the list, it will be removed from the list first |
| AddSavedAnimation | 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 |
| AddStickerToSet | Adds a new sticker to a set; for bots only. Returns the sticker set |
| Address | Describes an address |
| Animation | Describes an animation file. The animation must be encoded in GIF or MPEG4 format |
| Animations | Represents a list of animations |
| AnswerCallbackQuery | Sets the result of a callback query; for bots only |
| AnswerCustomQuery | Answers a custom query; for bots only |
| AnswerInlineQuery | Sets the result of an inline query; for bots only |
| AnswerPreCheckoutQuery | Sets the result of a pre-checkout query; for bots only |
| AnswerShippingQuery | Sets the result of a shipping query; for bots only |
| Audio | Describes an audio file. Audio is usually in MP3 or M4A format |
| AuthenticationCodeInfo | Information about the authentication code that was sent |
| AuthenticationCodeTypeCall | An authentication code is delivered via a phone call to the specified phone number |
| AuthenticationCodeTypeFlashCall | 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 |
| AuthenticationCodeTypeSms | An authentication code is delivered via an SMS message to the specified phone number |
| AuthenticationCodeTypeTelegramMessage | An authentication code is delivered via a private Telegram message, which can be viewed in another client |
| AuthorizationStateClosed | 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 |
| AuthorizationStateClosing | TDLib is closing, all subsequent queries will be answered with the error 500. Note that closing TDLib can take a while. All resources will be freed only after authorizationStateClosed has been received |
| AuthorizationStateLoggingOut | The user is currently logging out |
| AuthorizationStateReady | The user has been successfully authorized. TDLib is now ready to answer queries |
| AuthorizationStateWaitCode | TDLib needs the user's authentication code to authorize |
| AuthorizationStateWaitEncryptionKey | TDLib needs an encryption key to decrypt the local database |
| AuthorizationStateWaitOtherDeviceConfirmation | The user needs to confirm authorization on another logged in device by scanning a QR code with the provided link |
| AuthorizationStateWaitPassword | The user has been authorized, but needs to enter a password to start using the application |
| AuthorizationStateWaitPhoneNumber | TDLib needs the user's phone number to authorize. Call |
| AuthorizationStateWaitRegistration | The user is unregistered and need to accept terms of service and enter their first name and last name to finish registration |
| AuthorizationStateWaitTdlibParameters | TDLib needs TdlibParameters for initialization |
| AutoDownloadSettings | Contains auto-download settings |
| AutoDownloadSettingsPresets | Contains auto-download settings presets for the user |
| Background | Describes a chat background |
| BackgroundFillGradient | Describes a gradient fill of a background |
| BackgroundFillSolid | Describes a solid fill of a background |
| BackgroundTypeFill | A filled background |
| BackgroundTypePattern | A PNG or TGV (gzipped subset of SVG with mime-type "application/x-tgwallpattern") pattern to be combined with the background fill chosen by the user |
| BackgroundTypeWallpaper | A wallpaper in JPEG format |
| Backgrounds | Contains a list of backgrounds |
| BasicGroup | Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users) |
| BasicGroupFullInfo | Contains full information about a basic group |
| BlockUser | Adds a user to the blacklist |
| BotCommand | Represents commands supported by a bot |
| BotInfo | Provides information about a bot and its supported commands |
| Call | Describes a call |
| CallConnection | Describes the address of UDP reflectors |
| CallDiscardReasonDeclined | The call was ended before the conversation started. It was declined by the other party |
| CallDiscardReasonDisconnected | The call was ended during the conversation because the users were disconnected |
| CallDiscardReasonEmpty | The call wasn't discarded, or the reason is unknown |
| CallDiscardReasonHungUp | The call was ended because one of the parties hung up |
| CallDiscardReasonMissed | The call was ended before the conversation started. It was cancelled by the caller or missed by the other party |
| CallId | Contains the call identifier |
| CallProblemDistortedSpeech | The speech was distorted |
| CallProblemDropped | The call ended unexpectedly |
| CallProblemEcho | The user heard their own voice |
| CallProblemInterruptions | The other side kept disappearing |
| CallProblemNoise | The user heard background noise |
| CallProblemSilentLocal | The user couldn't hear the other side |
| CallProblemSilentRemote | The other side couldn't hear the user |
| CallProtocol | Specifies the supported call protocols |
| CallStateDiscarded | The call has ended successfully |
| CallStateError | The call has ended with an error |
| CallStateExchangingKeys | The call has been answered and encryption keys are being exchanged |
| CallStateHangingUp | The call is hanging up after discardCall has been called |
| CallStatePending | The call is pending, waiting to be accepted by a user |
| CallStateReady | The call is ready to use |
| CallbackQueryAnswer | Contains a bot's answer to a callback query |
| CallbackQueryPayloadData | The payload from a general callback button |
| CallbackQueryPayloadGame | The payload from a game callback button |
| CanTransferOwnership | Checks whether the current session can be used to transfer a chat ownership to another user |
| CanTransferOwnershipResultOk | The session can be used |
| CanTransferOwnershipResultPasswordNeeded | The 2-step verification needs to be enabled first |
| CanTransferOwnershipResultPasswordTooFresh | The 2-step verification was enabled recently, user needs to wait |
| CanTransferOwnershipResultSessionTooFresh | The session was created recently, user needs to wait |
| CancelDownloadFile | Stops the downloading of a file. If a file has already been downloaded, does nothing |
| CancelUploadFile | Stops the uploading of a file. Supported only for files uploaded by using uploadFile. For other files the behavior is undefined |
| ChangeImportedContacts | 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 |
| ChangePhoneNumber | 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 |
| ChangeStickerSet | Installs/uninstalls or activates/archives a sticker set |
| Chat | A chat. (Can be a private chat, basic group, supergroup, or secret chat) |
| ChatActionBarAddContact | The chat is a private or secret chat and the other user can be added to the contact list using the method addContact |
| ChatActionBarReportAddBlock | The chat is a private or secret chat, which can be reported using the method reportChat, or the other user can be added to the contact list using the method addContact, or the other user can be blocked using the method blockUser |
| ChatActionBarReportSpam | The chat can be reported as spam using the method reportChat with the reason chatReportReasonSpam |
| ChatActionBarReportUnrelatedLocation | The chat is a location-based supergroup, which can be reported as having unrelated location using the method reportChat with the reason chatReportReasonUnrelatedLocation |
| ChatActionBarSharePhoneNumber | The chat is a private or secret chat with a mutual contact and the user's phone number can be shared with the other user using the method sharePhoneNumber |
| ChatActionCancel | The user has cancelled the previous action |
| ChatActionChoosingContact | The user is picking a contact to send |
| ChatActionChoosingLocation | The user is picking a location or venue to send |
| ChatActionRecordingVideo | The user is recording a video |
| ChatActionRecordingVideoNote | The user is recording a video note |
| ChatActionRecordingVoiceNote | The user is recording a voice note |
| ChatActionStartPlayingGame | The user has started to play a game |
| ChatActionTyping | The user is typing a message |
| ChatActionUploadingDocument | The user is uploading a document |
| ChatActionUploadingPhoto | The user is uploading a photo |
| ChatActionUploadingVideo | The user is uploading a video |
| ChatActionUploadingVideoNote | The user is uploading a video note |
| ChatActionUploadingVoiceNote | The user is uploading a voice note |
| ChatAdministrator | Contains information about a chat administrator |
| ChatAdministrators | Represents a list of chat administrators |
| ChatEvent | Represents a chat event |
| ChatEventDescriptionChanged | The chat description was changed |
| ChatEventInvitesToggled | The can_invite_users permission of a supergroup chat was toggled |
| ChatEventIsAllHistoryAvailableToggled | The is_all_history_available setting of a supergroup was toggled |
| ChatEventLinkedChatChanged | The linked chat of a supergroup was changed |
| ChatEventLocationChanged | The supergroup location was changed |
| ChatEventLogFilters | Represents a set of filters used to obtain a chat event log |
| ChatEventMemberInvited | A new chat member was invited |
| ChatEventMemberJoined | A new member joined the chat |
| ChatEventMemberLeft | A member left the chat |
| ChatEventMemberPromoted | A chat member has gained/lost administrator status, or the list of their administrator privileges has changed |
| ChatEventMemberRestricted | A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed |
| ChatEventMessageDeleted | A message was deleted |
| ChatEventMessageEdited | A message was edited |
| ChatEventMessagePinned | A message was pinned |
| ChatEventMessageUnpinned | A message was unpinned |
| ChatEventPermissionsChanged | The chat permissions was changed |
| ChatEventPhotoChanged | The chat photo was changed |
| ChatEventPollStopped | A poll in a message was stopped |
| ChatEventSignMessagesToggled | The sign_messages setting of a channel was toggled |
| ChatEventSlowModeDelayChanged | The slow_mode_delay setting of a supergroup was changed |
| ChatEventStickerSetChanged | The supergroup sticker set was changed |
| ChatEventTitleChanged | The chat title was changed |
| ChatEventUsernameChanged | The chat username was changed |
| ChatEvents | Contains a list of chat events |
| ChatInviteLink | Contains a chat invite link |
| ChatInviteLinkInfo | Contains information about a chat invite link |
| ChatListArchive | A list of chats usually located at the top of the main chat list. Unmuted chats are automatically moved from the Archive to the Main chat list when a new message arrives |
| ChatListMain | A main list of chats |
| ChatLocation | Represents a location of a chat |
| ChatMember | A user with information about joining/leaving a chat |
| ChatMemberStatusAdministrator | 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 |
| ChatMemberStatusBanned | 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 |
| ChatMemberStatusCreator | The user is the owner of a chat and has all the administrator privileges |
| ChatMemberStatusLeft | The user is not a chat member |
| ChatMemberStatusMember | The user is a member of a chat, without any additional privileges or restrictions |
| ChatMemberStatusRestricted | The user is under certain restrictions in the chat. Not supported in basic groups and channels |
| ChatMembers | Contains a list of chat members |
| ChatMembersFilterAdministrators | Returns the owner and administrators |
| ChatMembersFilterBanned | Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel |
| ChatMembersFilterBots | Returns bot members of the chat |
| ChatMembersFilterContacts | Returns contacts of the user |
| ChatMembersFilterMembers | Returns all chat members, including restricted chat members |
| ChatMembersFilterRestricted | Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup |
| ChatNearby | Describes a chat located nearby |
| ChatNotificationSettings | Contains information about notification settings for a chat |
| ChatPermissions | Describes actions that a user is allowed to take in a chat |
| ChatPhoto | Describes the photo of a chat |
| ChatReportReasonChildAbuse | The chat has child abuse related content |
| ChatReportReasonCopyright | The chat contains copyrighted content |
| ChatReportReasonCustom | A custom reason provided by the user |
| ChatReportReasonPornography | The chat contains pornographic messages |
| ChatReportReasonSpam | The chat contains spam messages |
| ChatReportReasonUnrelatedLocation | The chat has unrelated location |
| ChatReportReasonViolence | The chat promotes violence |
| ChatTypeBasicGroup | A basic group (i.e., a chat with 0-200 other users) |
| ChatTypePrivate | An ordinary chat with a user |
| ChatTypeSecret | A secret chat with a user |
| ChatTypeSupergroup | A supergroup (i.e. a chat with up to GetOption("supergroup_max_size") other users), or channel (with unlimited members) |
| Chats | Represents a list of chats |
| ChatsNearby | Represents a list of chats located nearby |
| CheckAuthenticationBotToken | Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is authorizationStateWaitPhoneNumber. Can be used instead of setAuthenticationPhoneNumber and checkAuthenticationCode to log in |
| CheckAuthenticationCode | Checks the authentication code. Works only when the current authorization state is authorizationStateWaitCode |
| CheckAuthenticationPassword | Checks the authentication password for correctness. Works only when the current authorization state is authorizationStateWaitPassword |
| CheckChangePhoneNumberCode | Checks the authentication code sent to confirm a new phone number of the user |
| CheckChatInviteLink | Checks the validity of an invite link for a chat and returns information about the corresponding chat |
| CheckChatUsername | Checks whether a username can be set for a chat |
| CheckChatUsernameResultOk | The username can be set |
| CheckChatUsernameResultPublicChatsTooMuch | The user has too much chats with username, one of them should be made private first |
| CheckChatUsernameResultPublicGroupsUnavailable | The user can't be a member of a public supergroup |
| CheckChatUsernameResultUsernameInvalid | The username is invalid |
| CheckChatUsernameResultUsernameOccupied | The username is occupied |
| CheckCreatedPublicChatsLimit | Checks whether a maximum number of owned public chats is reached. Returns corresponding error if the limit was reached |
| CheckDatabaseEncryptionKey | Checks the database encryption key for correctness. Works only when the current authorization state is authorizationStateWaitEncryptionKey |
| CheckEmailAddressVerificationCode | Checks the email address verification code for Telegram Passport |
| CheckPhoneNumberConfirmationCode | Checks phone number confirmation code |
| CheckPhoneNumberVerificationCode | Checks the phone number verification code for Telegram Passport |
| CheckRecoveryEmailAddressCode | Checks the 2-step verification recovery email address verification code |
| CleanFileName | Removes potentially dangerous characters from the name of a file. The encoding of the file name is supposed to be UTF-8. Returns an empty string on failure. This is an offline method. Can be called before authorization. Can be called synchronously |
| ClearAllDraftMessages | Clears draft messages in all chats |
| ClearImportedContacts | Clears all imported contacts, contact list remains unchanged |
| ClearRecentStickers | Clears the list of recently used stickers |
| ClearRecentlyFoundChats | Clears the list of recently found chats |
| Close | Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes, updateAuthorizationState with authorizationStateClosed will be sent |
| CloseChat | Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed |
| CloseSecretChat | Closes a secret chat, effectively transfering its state to secretChatStateClosed |
| ConfirmQrCodeAuthentication | Confirms QR code authentication on another device. Returns created session on success |
| ConnectedWebsite | Contains information about one website the current user is logged in with Telegram |
| ConnectedWebsites | Contains a list of websites the current user is logged in with Telegram |
| ConnectionStateConnecting | Currently establishing a connection to the Telegram servers |
| ConnectionStateConnectingToProxy | Currently establishing a connection with a proxy server |
| ConnectionStateReady | There is a working connection to the Telegram servers |
| ConnectionStateUpdating | Downloading data received while the client was offline |
| ConnectionStateWaitingForNetwork | Currently waiting for the network to become available. Use setNetworkType to change the available network type |
| Contact | Describes a user contact |
| Count | Contains a counter |
| CreateBasicGroupChat | Returns an existing chat corresponding to a known basic group |
| CreateCall | Creates a new call |
| CreateNewBasicGroupChat | Creates a new basic group and sends a corresponding messageBasicGroupChatCreate. Returns the newly created chat |
| CreateNewSecretChat | Creates a new secret chat. Returns the newly created chat |
| CreateNewStickerSet | Creates a new sticker set; for bots only. Returns the newly created sticker set |
| CreateNewSupergroupChat | Creates a new supergroup or channel and sends a corresponding messageSupergroupChatCreate. Returns the newly created chat |
| CreatePrivateChat | Returns an existing chat corresponding to a given user |
| CreateSecretChat | Returns an existing chat corresponding to a known secret chat |
| CreateSupergroupChat | Returns an existing chat corresponding to a known supergroup or channel |
| CreateTemporaryPassword | Creates a new temporary password for processing payments |
| CustomRequestResult | Contains the result of a custom request |
| DatabaseStatistics | Contains database statistics |
| Date | Represents a date according to the Gregorian calendar |
| DatedFile | File with the date it was uploaded |
| DeepLinkInfo | Contains information about a tg:// deep link |
| DeleteAccount | 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 |
| DeleteChatHistory | 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 |
| DeleteChatMessagesFromUser | Deletes all messages sent by the specified user to a chat. Supported only for supergroups; requires can_delete_messages administrator privileges |
| DeleteChatReplyMarkup | 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 |
| DeleteFile | Deletes a file from the TDLib file cache |
| DeleteLanguagePack | Deletes all information about a language pack in the current localization target. The language pack which is currently in use (including base language pack) or is being synchronized can't be deleted. Can be called before authorization |
| DeleteMessages | Deletes messages |
| DeletePassportElement | Deletes a Telegram Passport element |
| DeleteProfilePhoto | Deletes a profile photo. If something changes, updateUser will be sent |
| DeleteSavedCredentials | Deletes saved credentials for all payment provider bots |
| DeleteSavedOrderInfo | Deletes saved order info |
| DeleteSupergroup | 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 |
| Destroy | Closes the TDLib instance, destroying all local data without a proper logout. The current user session will remain in the list of all active sessions. All local data will be destroyed. After the destruction completes updateAuthorizationState with authorizationStateClosed will be sent |
| DeviceTokenApplePush | A token for Apple Push Notification service |
| DeviceTokenApplePushVoIP | A token for Apple Push Notification service VoIP notifications |
| DeviceTokenBlackBerryPush | A token for BlackBerry Push Service |
| DeviceTokenFirebaseCloudMessaging | A token for Firebase Cloud Messaging |
| DeviceTokenMicrosoftPush | A token for Microsoft Push Notification Service |
| DeviceTokenMicrosoftPushVoIP | A token for Microsoft Push Notification Service VoIP channel |
| DeviceTokenSimplePush | A token for Simple Push API for Firefox OS |
| DeviceTokenTizenPush | A token for Tizen Push Service |
| DeviceTokenUbuntuPush | A token for Ubuntu Push Client service |
| DeviceTokenWebPush | A token for web Push API |
| DeviceTokenWindowsPush | A token for Windows Push Notification Services |
| DisableProxy | Disables the currently enabled proxy. Can be called before authorization |
| DiscardCall | Discards a call |
| DisconnectAllWebsites | Disconnects all websites from the current user's Telegram account |
| DisconnectWebsite | Disconnects website from the current user's Telegram account |
| Document | Describes a document of any type |
| DownloadFile | Downloads a file from the cloud. Download progress and completion of the download will be notified through updateFile updates |
| DraftMessage | Contains information about a message draft |
| EditCustomLanguagePackInfo | Edits information about a custom local language pack in the current localization target. Can be called before authorization |
| EditInlineMessageCaption | Edits the caption of an inline message sent via a bot; for bots only |
| EditInlineMessageLiveLocation | Edits the content of a live location in an inline message sent via a bot; for bots only |
| EditInlineMessageMedia | 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 |
| EditInlineMessageReplyMarkup | Edits the reply markup of an inline message sent via a bot; for bots only |
| EditInlineMessageText | Edits the text of an inline text or game message sent via a bot; for bots only |
| EditMessageCaption | Edits the message content caption. Returns the edited message after the edit is completed on the server side |
| EditMessageLiveLocation | 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 |
| EditMessageMedia | 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 |
| EditMessageReplyMarkup | Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side |
| EditMessageSchedulingState | 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 |
| EditMessageText | 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 |
| EditProxy | Edits an existing proxy server for network requests. Can be called before authorization |
| EmailAddressAuthenticationCodeInfo | Information about the email address authentication code that was sent |
| Emojis | Represents a list of emoji |
| EnableProxy | Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization |
| EncryptedCredentials | Contains encrypted Telegram Passport data credentials |
| EncryptedPassportElement | Contains information about an encrypted Telegram Passport element; for bots only |
| Error | An object of this type can be returned on every function call, in case of an error |
| File | Represents a file |
| FilePart | Contains a part of a file |
| FileTypeAnimation | The file is an animation |
| FileTypeAudio | The file is an audio file |
| FileTypeDocument | The file is a document |
| FileTypeNone | The data is not a file |
| FileTypePhoto | The file is a photo |
| FileTypeProfilePhoto | The file is a profile photo |
| FileTypeSecret | The file was sent to a secret chat (the file type is not known to the server) |
| FileTypeSecretThumbnail | The file is a thumbnail of a file from a secret chat |
| FileTypeSecure | The file is a file from Secure storage used for storing Telegram Passport files |
| FileTypeSticker | The file is a sticker |
| FileTypeThumbnail | The file is a thumbnail of another file |
| FileTypeUnknown | The file type is not yet known |
| FileTypeVideo | The file is a video |
| FileTypeVideoNote | The file is a video note |
| FileTypeVoiceNote | The file is a voice note |
| FileTypeWallpaper | The file is a wallpaper or a background pattern |
| FinishFileGeneration | Finishes the file generation |
| FormattedText | A text with some entities |
| ForwardMessages | 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 |
| FoundMessages | Contains a list of messages found by a search |
| Game | Describes a game |
| GameHighScore | Contains one row of the game high score table |
| GameHighScores | Contains a list of game high scores |
| GenerateChatInviteLink | 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 |
| GetAccountTtl | Returns the period of inactivity after which the account of the current user will automatically be deleted |
| GetActiveLiveLocationMessages | Returns all active live locations that should be updated by the client. The list is persistent across application restarts only if the message database is used |
| GetActiveSessions | Returns all active sessions of the current user |
| GetAllPassportElements | Returns all available Telegram Passport elements |
| GetApplicationConfig | Returns application config, provided by the server. Can be called before authorization |
| GetArchivedStickerSets | Returns a list of archived sticker sets |
| GetAttachedStickerSets | Returns a list of sticker sets attached to a file. Currently only photos and videos can have attached sticker sets |
| GetAuthorizationState | Returns the current authorization state; this is an offline request. For informational purposes only. Use updateAuthorizationState instead to maintain the current authorization state |
| GetAutoDownloadSettingsPresets | Returns auto-download settings presets for the currently logged in user |
| GetBackgroundUrl | Constructs a persistent HTTP URL for a background |
| GetBackgrounds | Returns backgrounds installed by the user |
| GetBasicGroup | Returns information about a basic group by its identifier. This is an offline request if the current user is not a bot |
| GetBasicGroupFullInfo | Returns full information about a basic group by its identifier |
| GetBlockedUsers | Returns users that were blocked by the current user |
| GetCallbackQueryAnswer | Sends a callback query to a bot and returns an answer. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires |
| GetChat | Returns information about a chat by its identifier, this is an offline request if the current user is not a bot |
| GetChatAdministrators | Returns a list of administrators of the chat with their custom titles |
| GetChatEventLog | 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) |
| GetChatHistory | 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 |
| GetChatMember | Returns information about a single member of a chat |
| GetChatMessageByDate | Returns the last message sent in a chat no later than the specified date |
| GetChatMessageCount | Returns approximate number of messages of the specified type in the chat |
| GetChatNotificationSettingsExceptions | Returns list of chats with non-default notification settings |
| GetChatPinnedMessage | Returns information about a pinned chat message |
| GetChatScheduledMessages | Returns all scheduled messages in a chat. The messages are returned in a reverse chronological order (i.e., in order of decreasing message_id) |
| GetChatStatisticsUrl | Returns an HTTP URL with the chat statistics. Currently this method can be used only for channels. Can be used only if SupergroupFullInfo.can_view_statistics == true |
| GetChats | Returns an ordered list of chats in a chat list. Chats are sorted by the pair (order, chat_id) in decreasing 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 |
| GetConnectedWebsites | Returns all website where the current user used Telegram to log in |
| GetContacts | Returns all user contacts |
| GetCountryCode | Uses current user IP to found their country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization |
| GetCreatedPublicChats | Returns a list of public chats of the specified type, owned by the user |
| GetCurrentState | Returns all updates needed to restore current TDLib state, i.e. all actual UpdateAuthorizationState/UpdateUser/UpdateNewChat and others. This is especially usefull if TDLib is run in a separate process. This is an offline method. Can be called before authorization |
| GetDatabaseStatistics | Returns database statistics |
| GetDeepLinkInfo | Returns information about a tg:// deep link. Use "tg://need_update_for_some_feature" or "tg:some_unsupported_feature" for testing. Returns a 404 error for unknown links. Can be called before authorization |
| GetEmojiSuggestionsUrl | Returns an HTTP URL which can be used to automatically log in to the translation platform and suggest new emoji replacements. The URL will be valid for 30 seconds after generation |
| GetFavoriteStickers | Returns favorite stickers |
| GetFile | Returns information about a file; this is an offline request |
| GetFileDownloadedPrefixSize | Returns file downloaded prefix size from a given offset |
| GetFileExtension | Returns the extension of a file, guessed by its MIME type. Returns an empty string on failure. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetFileMimeType | Returns the MIME type of a file, guessed by its extension. Returns an empty string on failure. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetGameHighScores | Returns the high scores for a game and some part of the high score table in the range of the specified user; for bots only |
| GetGroupsInCommon | Returns a list of common group chats with a given user. Chats are sorted by their type and creation date |
| GetImportedContactCount | Returns the total number of imported contacts |
| GetInactiveSupergroupChats | 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 |
| GetInlineGameHighScores | Returns game high scores and some part of the high score table in the range of the specified user; for bots only |
| GetInlineQueryResults | Sends an inline query to a bot and returns its results. Returns an error with code 502 if the bot fails to answer the query before the query timeout expires |
| GetInstalledStickerSets | Returns a list of installed sticker sets |
| GetInviteText | Returns the default text for invitation messages to be used as a placeholder when the current user invites friends to Telegram |
| GetJsonString | Converts a JsonValue object to corresponding JSON-serialized string. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetJsonValue | Converts a JSON-serialized string to corresponding JsonValue object. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetLanguagePackInfo | Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization |
| GetLanguagePackString | Returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetLanguagePackStrings | Returns strings from a language pack in the current localization target by their keys. Can be called before authorization |
| GetLocalizationTargetInfo | Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization |
| GetLogStream | Returns information about currently used log stream for internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetLogTagVerbosityLevel | Returns current verbosity level for a specified TDLib internal log tag. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetLogTags | Returns list of available TDLib internal log tags, for example, ["actor", "binlog", "connections", "notifications", "proxy"]. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetLogVerbosityLevel | Returns current verbosity level of the internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetLoginUrl | 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 |
| GetLoginUrlInfo | Returns information about a button of type inlineKeyboardButtonTypeLoginUrl. The method needs to be called when the user presses the button |
| GetMapThumbnailFile | Returns information about a file with a map thumbnail in PNG format. Only map thumbnail files with size less than 1MB can be downloaded |
| GetMe | Returns the current user |
| GetMessage | Returns information about a message |
| GetMessageLink | Returns a private HTTPS link to a message in a chat. Available only for already sent messages in supergroups and channels. The link will work only for members of the chat |
| GetMessageLinkInfo | Returns information about a public or private message link |
| GetMessageLocally | Returns information about a message, if it is available locally without sending network request. This is an offline request |
| GetMessages | Returns information about messages. If a message is not found, returns null on the corresponding position of the result |
| GetNetworkStatistics | Returns network data usage statistics. Can be called before authorization |
| GetOption | 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 |
| GetPassportAuthorizationForm | Returns a Telegram Passport authorization form for sharing data with a service |
| GetPassportAuthorizationFormAvailableElements | Returns already available Telegram Passport elements suitable for completing a Telegram Passport authorization form. Result can be received only once for each authorization form |
| GetPassportElement | Returns one of the available Telegram Passport elements |
| GetPasswordState | Returns the current state of 2-step verification |
| GetPaymentForm | Returns an invoice payment form. This method should be called when the user presses inlineKeyboardButtonBuy |
| GetPaymentReceipt | Returns information about a successful payment |
| GetPreferredCountryLanguage | 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 |
| GetProxies | Returns list of proxies that are currently set up. Can be called before authorization |
| GetProxyLink | Returns an HTTPS link, which can be used to add a proxy. Available only for SOCKS5 and MTProto proxies. Can be called before authorization |
| GetPublicMessageLink | Returns a public HTTPS link to a message. Available only for messages in supergroups and channels with a username |
| GetPushReceiverId | Returns a globally unique push notification subscription identifier for identification of an account, which has received a push notification. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetRecentInlineBots | Returns up to 20 recently used inline bots in the order of their last usage |
| GetRecentStickers | Returns a list of recently used stickers |
| GetRecentlyVisitedTMeUrls | Returns t.me URLs recently visited by a newly registered user |
| GetRecoveryEmailAddress | 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 |
| GetRemoteFile | 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 a file database is disabled, then the corresponding object with the file must be preloaded by the client |
| GetRepliedMessage | Returns information about a message that is replied by given message |
| GetSavedAnimations | Returns saved animations |
| GetSavedOrderInfo | Returns saved order info, if any |
| GetScopeNotificationSettings | Returns the notification settings for chats of a given type |
| GetSecretChat | Returns information about a secret chat by its identifier. This is an offline request |
| GetStickerEmojis | Returns emoji corresponding to a sticker. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object |
| GetStickerSet | Returns information about a sticker set by its identifier |
| GetStickers | 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 |
| GetStorageStatistics | Returns storage usage statistics. Can be called before authorization |
| GetStorageStatisticsFast | Quickly returns approximate storage usage statistics. Can be called before authorization |
| GetSuitableDiscussionChats | 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 |
| GetSupergroup | Returns information about a supergroup or a channel by its identifier. This is an offline request if the current user is not a bot |
| GetSupergroupFullInfo | Returns full information about a supergroup or a channel by its identifier, cached for up to 1 minute |
| GetSupergroupMembers | 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 |
| GetSupportUser | Returns a user that can be contacted to get support |
| GetTemporaryPasswordState | Returns information about the current temporary password |
| GetTextEntities | Returns all entities (mentions, hashtags, cashtags, bot commands, URLs, and email addresses) contained in the text. This is an offline method. Can be called before authorization. Can be called synchronously |
| GetTonWalletPasswordSalt | Returns a salt to be used with locally stored password to access a local TON-based wallet |
| GetTopChats | Returns a list of frequently used chats. Supported only if the chat info database is enabled |
| GetTrendingStickerSets | Returns a list of trending sticker sets |
| GetUser | Returns information about a user by their identifier. This is an offline request if the current user is not a bot |
| GetUserFullInfo | Returns full information about a user by their identifier |
| GetUserPrivacySettingRules | Returns the current privacy settings |
| GetUserProfilePhotos | Returns the profile photos of a user. The result of this query may be outdated: some photos might have been deleted already |
| GetWebPageInstantView | Returns an instant view version of a web page if available. Returns a 404 error if the web page has no instant view page |
| GetWebPagePreview | Returns a web page preview by the text of the message. Do not call this function too often. Returns a 404 error if the web page has no preview |
| Hashtags | Contains a list of hashtags |
| HttpUrl | Contains an HTTP URL |
| IdentityDocument | An identity document |
| ImportContacts | Adds new contacts or edits existing contacts by their phone numbers; contacts' user identifiers are ignored |
| ImportedContacts | Represents the result of an ImportContacts request |
| InlineKeyboardButton | Represents a single button in an inline keyboard |
| InlineKeyboardButtonTypeBuy | A button to buy something. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageInvoice |
| InlineKeyboardButtonTypeCallback | A button that sends a special callback query to a bot |
| InlineKeyboardButtonTypeCallbackGame | A button with a game that sends a special callback query to a bot. This button must be in the first column and row of the keyboard and can be attached only to a message with content of the type messageGame |
| InlineKeyboardButtonTypeLoginUrl | A button that opens a specified URL and automatically logs in in current user if they allowed to do that |
| InlineKeyboardButtonTypeSwitchInline | A button that forces an inline query to the bot to be inserted in the input field |
| InlineKeyboardButtonTypeUrl | A button that opens a specified URL |
| InlineQueryResultAnimation | Represents an animation file |
| InlineQueryResultArticle | Represents a link to an article or web page |
| InlineQueryResultAudio | Represents an audio file |
| InlineQueryResultContact | Represents a user contact |
| InlineQueryResultDocument | Represents a document |
| InlineQueryResultGame | Represents information about a game |
| InlineQueryResultLocation | Represents a point on the map |
| InlineQueryResultPhoto | Represents a photo |
| InlineQueryResultSticker | Represents a sticker |
| InlineQueryResultVenue | Represents information about a venue |
| InlineQueryResultVideo | Represents a video |
| InlineQueryResultVoiceNote | Represents a voice note |
| InlineQueryResults | Represents the results of the inline query. Use sendInlineQueryResultMessage to send the result of the query |
| InputBackgroundLocal | A background from a local file |
| InputBackgroundRemote | A background from the server |
| InputCredentialsAndroidPay | Applies if a user enters new credentials using Android Pay |
| InputCredentialsApplePay | Applies if a user enters new credentials using Apple Pay |
| InputCredentialsNew | Applies if a user enters new credentials on a payment provider website |
| InputCredentialsSaved | Applies if a user chooses some previously saved payment credentials. To use their previously saved credentials, the user must have a valid temporary password |
| InputFileGenerated | A file generated by the client |
| InputFileId | A file defined by its unique ID |
| InputFileLocal | A file defined by a local path |
| InputFileRemote | A file defined by its remote ID. The remote ID is guaranteed to be usable only if the corresponding file is still accessible to the user and known to TDLib. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If a file database is disabled, then the corresponding object with the file must be preloaded by the client |
| InputIdentityDocument | An identity document to be saved to Telegram Passport |
| InputInlineQueryResultAnimatedGif | Represents a link to an animated GIF |
| InputInlineQueryResultAnimatedMpeg4 | Represents a link to an animated (i.e. without sound) H.264/MPEG-4 AVC video |
| InputInlineQueryResultArticle | Represents a link to an article or web page |
| InputInlineQueryResultAudio | Represents a link to an MP3 audio file |
| InputInlineQueryResultContact | Represents a user contact |
| InputInlineQueryResultDocument | Represents a link to a file |
| InputInlineQueryResultGame | Represents a game |
| InputInlineQueryResultLocation | Represents a point on the map |
| InputInlineQueryResultPhoto | Represents link to a JPEG image |
| InputInlineQueryResultSticker | Represents a link to a WEBP or TGS sticker |
| InputInlineQueryResultVenue | Represents information about a venue |
| InputInlineQueryResultVideo | Represents a link to a page containing an embedded video player or a video file |
| InputInlineQueryResultVoiceNote | Represents a link to an opus-encoded audio file within an OGG container, single channel audio |
| InputMessageAnimation | An animation message (GIF-style). |
| InputMessageAudio | An audio message |
| InputMessageContact | A message containing a user contact |
| InputMessageDocument | A document message (general file) |
| InputMessageForwarded | A forwarded message |
| InputMessageGame | A message with a game; not supported for channels or secret chats |
| InputMessageInvoice | A message with an invoice; can be used only by bots and only in private chats |
| InputMessageLocation | A message with a location |
| InputMessagePhoto | A photo message |
| InputMessagePoll | A message with a poll. Polls can't be sent to private or secret chats |
| InputMessageSticker | A sticker message |
| InputMessageText | A text message |
| InputMessageVenue | A message with information about a venue |
| InputMessageVideo | A video message |
| InputMessageVideoNote | A video note message |
| InputMessageVoiceNote | A voice note message |
| InputPassportElementAddress | A Telegram Passport element to be saved containing the user's address |
| InputPassportElementBankStatement | A Telegram Passport element to be saved containing the user's bank statement |
| InputPassportElementDriverLicense | A Telegram Passport element to be saved containing the user's driver license |
| InputPassportElementEmailAddress | A Telegram Passport element to be saved containing the user's email address |
| InputPassportElementError | Contains the description of an error in a Telegram Passport element; for bots only |
| InputPassportElementErrorSourceDataField | A data field contains an error. The error is considered resolved when the field's value changes |
| InputPassportElementErrorSourceFile | The file contains an error. The error is considered resolved when the file changes |
| InputPassportElementErrorSourceFiles | The list of attached files contains an error. The error is considered resolved when the file list changes |
| InputPassportElementErrorSourceFrontSide | The front side of the document contains an error. The error is considered resolved when the file with the front side of the document changes |
| InputPassportElementErrorSourceReverseSide | The reverse side of the document contains an error. The error is considered resolved when the file with the reverse side of the document changes |
| InputPassportElementErrorSourceSelfie | The selfie contains an error. The error is considered resolved when the file with the selfie changes |
| InputPassportElementErrorSourceTranslationFile | One of the files containing the translation of the document contains an error. The error is considered resolved when the file with the translation changes |
| InputPassportElementErrorSourceTranslationFiles | The translation of the document contains an error. The error is considered resolved when the list of files changes |
| InputPassportElementErrorSourceUnspecified | The element contains an error in an unspecified place. The error will be considered resolved when new data is added |
| InputPassportElementIdentityCard | A Telegram Passport element to be saved containing the user's identity card |
| InputPassportElementInternalPassport | A Telegram Passport element to be saved containing the user's internal passport |
| InputPassportElementPassport | A Telegram Passport element to be saved containing the user's passport |
| InputPassportElementPassportRegistration | A Telegram Passport element to be saved containing the user's passport registration |
| InputPassportElementPersonalDetails | A Telegram Passport element to be saved containing the user's personal details |
| InputPassportElementPhoneNumber | A Telegram Passport element to be saved containing the user's phone number |
| InputPassportElementRentalAgreement | A Telegram Passport element to be saved containing the user's rental agreement |
| InputPassportElementTemporaryRegistration | A Telegram Passport element to be saved containing the user's temporary registration |
| InputPassportElementUtilityBill | A Telegram Passport element to be saved containing the user's utility bill |
| InputPersonalDocument | A personal document to be saved to Telegram Passport |
| InputSticker | Describes a sticker that should be added to a sticker set |
| InputThumbnail | A thumbnail to be sent along with a file; should be in JPEG or WEBP format for stickers, and less than 200 kB in size |
| Invoice | Product invoice |
| JoinChat | Adds current user as a new member to a chat. Private and secret chats can't be joined using this method |
| JoinChatByInviteLink | 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 |
| JsonObjectMember | Represents one member of a JSON object |
| JsonValueArray | Represents a JSON array |
| JsonValueBoolean | Represents a boolean JSON value |
| JsonValueNull | Represents a null JSON value |
| JsonValueNumber | Represents a numeric JSON value |
| JsonValueObject | Represents a JSON object |
| JsonValueString | Represents a string JSON value |
| KeyboardButton | Represents a single button in a bot keyboard |
| KeyboardButtonTypeRequestLocation | A button that sends the user's location when pressed; available only in private chats |
| KeyboardButtonTypeRequestPhoneNumber | A button that sends the user's phone number when pressed; available only in private chats |
| KeyboardButtonTypeText | A simple button, with text that should be sent when the button is pressed |
| LabeledPricePart | Portion of the price of a product (e.g., "delivery cost", "tax amount") |
| LanguagePackInfo | Contains information about a language pack |
| LanguagePackString | Represents one language pack string |
| LanguagePackStringValueDeleted | A deleted language pack string, the value should be taken from the built-in english language pack |
| LanguagePackStringValueOrdinary | An ordinary language pack string |
| LanguagePackStringValuePluralized | 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 |
| LanguagePackStrings | Contains a list of language pack strings |
| LeaveChat | Removes current user from chat members. Private and secret chats can't be left using this method |
| LocalFile | Represents a local file |
| LocalizationTargetInfo | Contains information about the current localization target |
| Location | Describes a location on planet Earth |
| LogOut | Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be destroyed. After the logout completes, updateAuthorizationState with authorizationStateClosed will be sent |
| LogStreamDefault | The log is written to stderr or an OS specific log |
| LogStreamEmpty | The log is written nowhere |
| LogStreamFile | The log is written to a file |
| LogTags | Contains a list of available TDLib internal log tags |
| LogVerbosityLevel | Contains a TDLib internal log verbosity level |
| LoginUrlInfoOpen | An HTTP url needs to be open |
| LoginUrlInfoRequestConfirmation | An authorization confirmation dialog needs to be shown to the user |
| MaskPointChin | A mask should be placed relatively to the chin |
| MaskPointEyes | A mask should be placed relatively to the eyes |
| MaskPointForehead | A mask should be placed relatively to the forehead |
| MaskPointMouth | A mask should be placed relatively to the mouth |
| MaskPosition | Position on a photo where a mask should be placed |
| Message | Describes a message |
| MessageAnimation | An animation message (GIF-style). |
| MessageAudio | An audio message |
| MessageBasicGroupChatCreate | A newly created basic group |
| MessageCall | A message with information about an ended call |
| MessageChatAddMembers | New chat members were added |
| MessageChatChangePhoto | An updated chat photo |
| MessageChatChangeTitle | An updated chat title |
| MessageChatDeleteMember | A chat member was deleted |
| MessageChatDeletePhoto | A deleted chat photo |
| MessageChatJoinByLink | A new member joined the chat by invite link |
| MessageChatSetTtl | The TTL (Time To Live) setting messages in a secret chat has been changed |
| MessageChatUpgradeFrom | A supergroup has been created from a basic group |
| MessageChatUpgradeTo | A basic group was upgraded to a supergroup and was deactivated as the result |
| MessageContact | A message with a user contact |
| MessageContactRegistered | A contact has registered with Telegram |
| MessageCustomServiceAction | A non-standard action has happened in the chat |
| MessageDocument | A document message (general file) |
| MessageExpiredPhoto | An expired photo message (self-destructed after TTL has elapsed) |
| MessageExpiredVideo | An expired video message (self-destructed after TTL has elapsed) |
| MessageForwardInfo | Contains information about a forwarded message |
| MessageForwardOriginChannel | The message was originally a post in a channel |
| MessageForwardOriginHiddenUser | The message was originally written by a user, which is hidden by their privacy settings |
| MessageForwardOriginUser | The message was originally written by a known user |
| MessageGame | A message with a game |
| MessageGameScore | A new high score was achieved in a game |
| MessageInvoice | A message with an invoice from a bot |
| MessageLinkInfo | Contains information about a link to a message in a chat |
| MessageLocation | A message with a location |
| MessagePassportDataReceived | Telegram Passport data has been received; for bots only |
| MessagePassportDataSent | Telegram Passport data has been sent |
| MessagePaymentSuccessful | A payment has been completed |
| MessagePaymentSuccessfulBot | A payment has been completed; for bots only |
| MessagePhoto | A photo message |
| MessagePinMessage | A message has been pinned |
| MessagePoll | A message with a poll |
| MessageSchedulingStateSendAtDate | The message will be sent at the specified date |
| MessageSchedulingStateSendWhenOnline | The message will be sent when the peer will be online. Applicable to private chats only and when the exact online status of the peer is known |
| MessageScreenshotTaken | A screenshot of a message in the chat has been taken |
| MessageSendingStateFailed | The message failed to be sent |
| MessageSendingStatePending | The message is being sent now, but has not yet been delivered to the server |
| MessageSticker | A sticker message |
| MessageSupergroupChatCreate | A newly created supergroup or channel |
| MessageText | A text message |
| MessageUnsupported | Message content that is not supported by the client |
| MessageVenue | A message with information about a venue |
| MessageVideo | A video message |
| MessageVideoNote | A video note message |
| MessageVoiceNote | A voice note message |
| MessageWebsiteConnected | The current user has connected a website by logging in using Telegram Login Widget on it |
| Messages | Contains a list of messages |
| Minithumbnail | Thumbnail image of a very poor quality and low resolution |
| NetworkStatistics | A full list of available network statistic entries |
| NetworkStatisticsEntryCall | Contains information about the total amount of data that was used for calls |
| NetworkStatisticsEntryFile | Contains information about the total amount of data that was used to send and receive files |
| NetworkTypeMobile | A mobile network |
| NetworkTypeMobileRoaming | A mobile roaming network |
| NetworkTypeNone | The network is not available |
| NetworkTypeOther | A different network type (e.g., Ethernet network) |
| NetworkTypeWiFi | A Wi-Fi network |
| Notification | Contains information about a notification |
| NotificationGroup | Describes a group of notifications |
| NotificationGroupTypeCalls | A group containing notifications of type notificationTypeNewCall |
| NotificationGroupTypeMentions | A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with unread mentions of the current user, replies to their messages, or a pinned message |
| NotificationGroupTypeMessages | A group containing notifications of type notificationTypeNewMessage and notificationTypeNewPushMessage with ordinary unread messages |
| NotificationGroupTypeSecretChat | A group containing a notification of type notificationTypeNewSecretChat |
| NotificationSettingsScopeChannelChats | Notification settings applied to all channels when the corresponding chat setting has a default value |
| NotificationSettingsScopeGroupChats | Notification settings applied to all basic groups and supergroups when the corresponding chat setting has a default value |
| NotificationSettingsScopePrivateChats | Notification settings applied to all private and secret chats when the corresponding chat setting has a default value |
| NotificationTypeNewCall | New call was received |
| NotificationTypeNewMessage | New message was received |
| NotificationTypeNewPushMessage | New message was received through a push notification |
| NotificationTypeNewSecretChat | New secret chat was created |
| Ok | An object of this type is returned on a successful function call for certain functions |
| OpenChat | Informs TDLib that the chat is opened by the user. Many useful activities depend on the chat being opened or closed (e.g., in supergroups and channels all updates are received only for opened chats) |
| OpenMessageContent | Informs TDLib that the message content has been opened (e.g., the user has opened a photo, video, document, location or venue, or has listened to an audio file or voice note message). An updateMessageContentOpened update will be generated if something has changed |
| OptimizeStorage | Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted |
| OptionValueBoolean | Represents a boolean option |
| OptionValueEmpty | Represents an unknown option or an option which has a default value |
| OptionValueInteger | Represents an integer option |
| OptionValueString | Represents a string option |
| OrderInfo | Order information |
| PageBlockAnchor | An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor |
| PageBlockAnimation | An animation |
| PageBlockAudio | An audio file |
| PageBlockAuthorDate | The author and publishing date of a page |
| PageBlockBlockQuote | A block quote |
| PageBlockCaption | Contains a caption of an instant view web page block, consisting of a text and a trailing credit |
| PageBlockChatLink | A link to a chat |
| PageBlockCollage | A collage |
| PageBlockCover | A page cover |
| PageBlockDetails | A collapsible block |
| PageBlockDivider | An empty block separating a page |
| PageBlockEmbedded | An embedded web page |
| PageBlockEmbeddedPost | An embedded post |
| PageBlockFooter | The footer of a page |
| PageBlockHeader | A header |
| PageBlockHorizontalAlignmentCenter | The content should be center-aligned |
| PageBlockHorizontalAlignmentLeft | The content should be left-aligned |
| PageBlockHorizontalAlignmentRight | The content should be right-aligned |
| PageBlockKicker | A kicker |
| PageBlockList | A list of data blocks |
| PageBlockListItem | Describes an item of a list page block |
| PageBlockMap | A map |
| PageBlockParagraph | A text paragraph |
| PageBlockPhoto | A photo |
| PageBlockPreformatted | A preformatted text paragraph |
| PageBlockPullQuote | A pull quote |
| PageBlockRelatedArticle | Contains information about a related article |
| PageBlockRelatedArticles | Related articles |
| PageBlockSlideshow | A slideshow |
| PageBlockSubheader | A subheader |
| PageBlockSubtitle | The subtitle of a page |
| PageBlockTable | A table |
| PageBlockTableCell | Represents a cell of a table |
| PageBlockTitle | The title of a page |
| PageBlockVerticalAlignmentBottom | The content should be bottom-aligned |
| PageBlockVerticalAlignmentMiddle | The content should be middle-aligned |
| PageBlockVerticalAlignmentTop | The content should be top-aligned |
| PageBlockVideo | A video |
| PageBlockVoiceNote | A voice note |
| ParseTextEntities | Parses Bold, Italic, Underline, Strikethrough, Code, Pre, PreCode, TextUrl and MentionName entities contained in the text. This is an offline method. Can be called before authorization. Can be called synchronously |
| PassportAuthorizationForm | Contains information about a Telegram Passport authorization form that was requested |
| PassportElementAddress | A Telegram Passport element containing the user's address |
| PassportElementBankStatement | A Telegram Passport element containing the user's bank statement |
| PassportElementDriverLicense | A Telegram Passport element containing the user's driver license |
| PassportElementEmailAddress | A Telegram Passport element containing the user's email address |
| PassportElementError | Contains the description of an error in a Telegram Passport element |
| PassportElementErrorSourceDataField | One of the data fields contains an error. The error will be considered resolved when the value of the field changes |
| PassportElementErrorSourceFile | The file contains an error. The error will be considered resolved when the file changes |
| PassportElementErrorSourceFiles | The list of attached files contains an error. The error will be considered resolved when the list of files changes |
| PassportElementErrorSourceFrontSide | The front side of the document contains an error. The error will be considered resolved when the file with the front side changes |
| PassportElementErrorSourceReverseSide | The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes |
| PassportElementErrorSourceSelfie | The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes |
| PassportElementErrorSourceTranslationFile | One of files with the translation of the document contains an error. The error will be considered resolved when the file changes |
| PassportElementErrorSourceTranslationFiles | The translation of the document contains an error. The error will be considered resolved when the list of translation files changes |
| PassportElementErrorSourceUnspecified | The element contains an error in an unspecified place. The error will be considered resolved when new data is added |
| PassportElementIdentityCard | A Telegram Passport element containing the user's identity card |
| PassportElementInternalPassport | A Telegram Passport element containing the user's internal passport |
| PassportElementPassport | A Telegram Passport element containing the user's passport |
| PassportElementPassportRegistration | A Telegram Passport element containing the user's passport registration pages |
| PassportElementPersonalDetails | A Telegram Passport element containing the user's personal details |
| PassportElementPhoneNumber | A Telegram Passport element containing the user's phone number |
| PassportElementRentalAgreement | A Telegram Passport element containing the user's rental agreement |
| PassportElementTemporaryRegistration | A Telegram Passport element containing the user's temporary registration |
| PassportElementTypeAddress | A Telegram Passport element containing the user's address |
| PassportElementTypeBankStatement | A Telegram Passport element containing the user's bank statement |
| PassportElementTypeDriverLicense | A Telegram Passport element containing the user's driver license |
| PassportElementTypeEmailAddress | A Telegram Passport element containing the user's email address |
| PassportElementTypeIdentityCard | A Telegram Passport element containing the user's identity card |
| PassportElementTypeInternalPassport | A Telegram Passport element containing the user's internal passport |
| PassportElementTypePassport | A Telegram Passport element containing the user's passport |
| PassportElementTypePassportRegistration | A Telegram Passport element containing the registration page of the user's passport |
| PassportElementTypePersonalDetails | A Telegram Passport element containing the user's personal details |
| PassportElementTypePhoneNumber | A Telegram Passport element containing the user's phone number |
| PassportElementTypeRentalAgreement | A Telegram Passport element containing the user's rental agreement |
| PassportElementTypeTemporaryRegistration | A Telegram Passport element containing the user's temporary registration |
| PassportElementTypeUtilityBill | A Telegram Passport element containing the user's utility bill |
| PassportElementUtilityBill | A Telegram Passport element containing the user's utility bill |
| PassportElements | Contains information about saved Telegram Passport elements |
| PassportElementsWithErrors | Contains information about a Telegram Passport elements and corresponding errors |
| PassportRequiredElement | Contains a description of the required Telegram Passport element that was requested by a service |
| PassportSuitableElement | Contains information about a Telegram Passport element that was requested by a service |
| PasswordState | Represents the current state of 2-step verification |
| PaymentForm | Contains information about an invoice payment form |
| PaymentReceipt | Contains information about a successful payment |
| PaymentResult | Contains the result of a payment request |
| PaymentsProviderStripe | Stripe payment provider |
| PersonalDetails | Contains the user's personal details |
| PersonalDocument | A personal document, containing some information about a user |
| PhoneNumberAuthenticationSettings | Contains settings for the authentication of the user's phone number |
| Photo | Describes a photo |
| PhotoSize | Photo description |
| PinChatMessage | Pins a message in a chat; requires can_pin_messages rights |
| PingProxy | Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization |
| Poll | Describes a poll |
| PollOption | Describes one answer option of a poll |
| ProcessPushNotification | Handles a push notification. Returns error with code 406 if the push notification is not supported and connection to the server is required to fetch new data. Can be called before authorization |
| ProfilePhoto | Describes a user profile photo |
| Proxies | Represents a list of proxy servers |
| Proxy | Contains information about a proxy server |
| ProxyTypeHttp | A HTTP transparent proxy server |
| ProxyTypeMtproto | An MTProto proxy server |
| ProxyTypeSocks5 | A SOCKS5 proxy server |
| PublicChatTypeHasUsername | The chat is public, because it has username |
| PublicChatTypeIsLocationBased | The chat is public, because it is a location-based supergroup |
| PublicMessageLink | Contains a public HTTPS link to a message in a supergroup or channel with a username |
| PushMessageContentAnimation | An animation message (GIF-style). |
| PushMessageContentAudio | An audio message |
| PushMessageContentBasicGroupChatCreate | A newly created basic group |
| PushMessageContentChatAddMembers | New chat members were invited to a group |
| PushMessageContentChatChangePhoto | A chat photo was edited |
| PushMessageContentChatChangeTitle | A chat title was edited |
| PushMessageContentChatDeleteMember | A chat member was deleted |
| PushMessageContentChatJoinByLink | A new member joined the chat by invite link |
| PushMessageContentContact | A message with a user contact |
| PushMessageContentContactRegistered | A contact has registered with Telegram |
| PushMessageContentDocument | A document message (a general file) |
| PushMessageContentGame | A message with a game |
| PushMessageContentGameScore | A new high score was achieved in a game |
| PushMessageContentHidden | A general message with hidden content |
| PushMessageContentInvoice | A message with an invoice from a bot |
| PushMessageContentLocation | A message with a location |
| PushMessageContentMediaAlbum | A media album |
| PushMessageContentMessageForwards | A forwarded messages |
| PushMessageContentPhoto | A photo message |
| PushMessageContentPoll | A message with a poll |
| PushMessageContentScreenshotTaken | A screenshot of a message in the chat has been taken |
| PushMessageContentSticker | A message with a sticker |
| PushMessageContentText | A text message |
| PushMessageContentVideo | A video message |
| PushMessageContentVideoNote | A video note message |
| PushMessageContentVoiceNote | A voice note message |
| PushReceiverId | Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification |
| ReadAllChatMentions | Marks all mentions in a chat as read |
| ReadFilePart | Reads a part of a file from the TDLib file cache and returns read bytes. This method is intended to be used only if the client has no direct access to TDLib's file system, because it is usually slower than a direct read from the file |
| RecoverAuthenticationPassword | 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 |
| RecoverPassword | Recovers the password using a recovery code sent to an email address that was previously set up |
| RecoveryEmailAddress | Contains information about the current recovery email address |
| RegisterDevice | Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription |
| RegisterUser | Finishes user registration. Works only when the current authorization state is authorizationStateWaitRegistration |
| RemoteFile | Represents a remote file |
| RemoveBackground | Removes background from the list of installed backgrounds |
| RemoveChatActionBar | Removes a chat action bar without any other action |
| RemoveContacts | Removes users from the contact list |
| RemoveFavoriteSticker | Removes a sticker from the list of favorite stickers |
| RemoveNotification | Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user |
| RemoveNotificationGroup | Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user |
| RemoveProxy | Removes a proxy server. Can be called before authorization |
| RemoveRecentHashtag | Removes a hashtag from the list of recently used hashtags |
| RemoveRecentSticker | Removes a sticker from the list of recently used stickers |
| RemoveRecentlyFoundChat | Removes a chat from the list of recently found chats |
| RemoveSavedAnimation | Removes an animation from the list of saved animations |
| RemoveStickerFromSet | Removes a sticker from the set to which it belongs; for bots only. The sticker set must have been created by the bot |
| RemoveTopChat | Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled |
| ReorderInstalledStickerSets | Changes the order of installed sticker sets |
| ReplyMarkupForceReply | Instructs clients to force a reply to this message |
| ReplyMarkupInlineKeyboard | Contains an inline keyboard layout |
| ReplyMarkupRemoveKeyboard | Instructs clients to remove the keyboard once this message has been received. This kind of keyboard can't be received in an incoming message; instead, UpdateChatReplyMarkup with message_id == 0 will be sent |
| ReplyMarkupShowKeyboard | Contains a custom keyboard layout to quickly reply to bots |
| ReportChat | Reports a chat to the Telegram moderators. Supported only for supergroups, channels, or private chats with bots, since other chats can't be checked by moderators, or when the report is done from the chat action bar |
| ReportSupergroupSpam | Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup |
| RequestAuthenticationPasswordRecovery | 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 |
| RequestPasswordRecovery | Requests to send a password recovery code to an email address that was previously set up |
| RequestQrCodeAuthentication | Requests QR code authentication by scanning a QR code on another logged in device. Works only when the current authorization state is authorizationStateWaitPhoneNumber |
| ResendAuthenticationCode | 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 |
| ResendChangePhoneNumberCode | 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 |
| ResendEmailAddressVerificationCode | Re-sends the code to verify an email address to be added to a user's Telegram Passport |
| ResendMessages | Resends messages which failed to send. Can be called only for messages for which messageSendingStateFailed.can_retry is true and after specified in messageSendingStateFailed.retry_after time passed. If a message is re-sent, the corresponding failed to send message is deleted. Returns the sent messages in the same order as the message identifiers passed in message_ids. If a message can't be re-sent, null will be returned instead of the message |
| ResendPhoneNumberConfirmationCode | Resends phone number confirmation code |
| ResendPhoneNumberVerificationCode | Re-sends the code to verify a phone number to be added to a user's Telegram Passport |
| ResendRecoveryEmailAddressCode | Resends the 2-step verification recovery email address verification code |
| ResetAllNotificationSettings | 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 |
| ResetBackgrounds | Resets list of installed backgrounds to its default value |
| ResetNetworkStatistics | Resets all network data usage statistics to zero. Can be called before authorization |
| RichTextAnchor | A rich text anchor |
| RichTextBold | A bold rich text |
| RichTextEmailAddress | A rich text email link |
| RichTextFixed | A fixed-width rich text |
| RichTextIcon | A small image inside the text |
| RichTextItalic | An italicized rich text |
| RichTextMarked | A marked rich text |
| RichTextPhoneNumber | A rich text phone number |
| RichTextPlain | A plain text |
| RichTextStrikethrough | A strikethrough rich text |
| RichTextSubscript | A subscript rich text |
| RichTextSuperscript | A superscript rich text |
| RichTextUnderline | An underlined rich text |
| RichTextUrl | A rich text URL link |
| RichTexts | A concatenation of rich texts |
| SaveApplicationLogEvent | Saves application log event on the server. Can be called before authorization |
| SavedCredentials | Contains information about saved card credentials |
| ScopeNotificationSettings | Contains information about notification settings for several chats |
| SearchBackground | Searches for a background by its name |
| SearchCallMessages | 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 |
| SearchChatMembers | 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 |
| SearchChatMessages | 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 |
| SearchChatRecentLocationMessages | Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user |
| SearchChats | Searches for the specified query in the title and username of already known chats, this is an offline request. Returns chats in the order seen in the chat list |
| SearchChatsNearby | 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 |
| SearchChatsOnServer | Searches for the specified query in the title and username of already known chats via request to the server. Returns chats in the order seen in the chat list |
| SearchContacts | Searches for the specified query in the first names, last names and usernames of the known user contacts |
| SearchEmojis | Searches for emojis by keywords. Supported only if the file database is enabled |
| SearchHashtags | Searches for recently used hashtags by their prefix |
| SearchInstalledStickerSets | Searches for installed sticker sets by looking for specified query in their title and name |
| SearchMessages | 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 |
| SearchMessagesFilterAnimation | Returns only animation messages |
| SearchMessagesFilterAudio | Returns only audio messages |
| SearchMessagesFilterCall | Returns only call messages |
| SearchMessagesFilterChatPhoto | Returns only messages containing chat photos |
| SearchMessagesFilterDocument | Returns only document messages |
| SearchMessagesFilterEmpty | Returns all found messages, no filter is applied |
| SearchMessagesFilterMention | Returns only messages with mentions of the current user, or messages that are replies to their messages |
| SearchMessagesFilterMissedCall | Returns only incoming call messages with missed/declined discard reasons |
| SearchMessagesFilterPhoto | Returns only photo messages |
| SearchMessagesFilterPhotoAndVideo | Returns only photo and video messages |
| SearchMessagesFilterUnreadMention | Returns only messages with unread mentions of the current user, or messages that are replies to their messages. When using this filter the results can't be additionally filtered by a query or by the sending user |
| SearchMessagesFilterUrl | Returns only messages containing URLs |
| SearchMessagesFilterVideo | Returns only video messages |
| SearchMessagesFilterVideoNote | Returns only video note messages |
| SearchMessagesFilterVoiceAndVideoNote | Returns only voice and video note messages |
| SearchMessagesFilterVoiceNote | Returns only voice note messages |
| SearchPublicChat | 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 |
| SearchPublicChats | 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 |
| SearchSecretMessages | 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 |
| SearchStickerSet | Searches for a sticker set by its name |
| SearchStickerSets | Searches for ordinary sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results |
| SearchStickers | Searches for stickers from public sticker sets that correspond to a given emoji |
| Seconds | Contains a value representing a number of seconds |
| SecretChat | Represents a secret chat |
| SecretChatStateClosed | The secret chat is closed |
| SecretChatStatePending | The secret chat is not yet created; waiting for the other user to get online |
| SecretChatStateReady | The secret chat is ready to use |
| SendBotStartMessage | Invites a bot to a chat (if it is not yet a member) and sends it the /start command. Bots can't be invited to a private chat other than the chat with the bot. Bots can't be invited to channels (although they can be added as admins) and secret chats. Returns the sent message |
| SendCallDebugInformation | Sends debug information for a call |
| SendCallRating | Sends a call rating |
| SendChatAction | Sends a notification about user activity in a chat |
| SendChatScreenshotTakenNotification | Sends a notification about a screenshot taken in a chat. Supported only in private and secret chats |
| SendChatSetTtlMessage | Changes the current TTL setting (sets a new self-destruct timer) in a secret chat and sends the corresponding message |
| SendCustomRequest | Sends a custom request; for bots only |
| SendEmailAddressVerificationCode | Sends a code to verify an email address to be added to a user's Telegram Passport |
| SendInlineQueryResultMessage | Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message |
| SendMessage | Sends a message. Returns the sent message |
| SendMessageAlbum | Sends messages grouped together into an album. Currently only photo and video messages can be grouped into an album. Returns sent messages |
| SendMessageOptions | Options to be used when a message is send |
| SendPassportAuthorizationForm | 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 |
| SendPaymentForm | Sends a filled-out payment form to the bot for final verification |
| SendPhoneNumberConfirmationCode | Sends phone number confirmation code. Should be called when user presses "https://t.me/confirmphone?phone=&hash=" or "tg://confirmphone?phone=&hash=******" link |
| SendPhoneNumberVerificationCode | Sends a code to verify a phone number to be added to a user's Telegram Passport |
| SendTonLiteServerRequest | Sends a request to TON lite server through Telegram servers. Can be called before authorization |
| Session | 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 |
| Sessions | Contains a list of sessions |
| SetAccountTtl | Changes the period of inactivity after which the account of the current user will automatically be deleted |
| SetAlarm | Succeeds after a specified amount of time has passed. Can be called before authorization. Can be called before initialization |
| SetAuthenticationPhoneNumber | 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 or authorizationStateWaitPassword |
| SetAutoDownloadSettings | Sets auto-download settings |
| SetBackground | Changes the background selected by the user; adds background to the list of installed backgrounds |
| SetBio | Changes the bio of the current user |
| SetBotUpdatesStatus | Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only |
| SetChatChatList | Moves a chat to a different chat list. Current chat list of the chat must ne non-null |
| SetChatClientData | Changes client data associated with a chat |
| SetChatDescription | Changes information about a chat. Available for basic groups, supergroups, and channels. Requires can_change_info rights |
| SetChatDiscussionGroup | Changes the discussion group of a channel chat; requires can_change_info rights in the channel if it is specified |
| SetChatDraftMessage | Changes the draft message in a chat |
| SetChatLocation | Changes the location of a chat. Available only for some location-based supergroups, use supergroupFullInfo.can_set_location to check whether the method is allowed to use |
| SetChatMemberStatus | 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 |
| SetChatNotificationSettings | Changes the notification settings of a chat. Notification settings of a chat with the current user (Saved Messages) can't be changed |
| SetChatPermissions | Changes the chat members permissions. Supported only for basic groups and supergroups. Requires can_restrict_members administrator right |
| SetChatPhoto | Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires can_change_info rights. The photo will not be changed before request to the server has been completed |
| SetChatSlowModeDelay | Changes the slow mode delay of a chat. Available only for supergroups; requires can_restrict_members rights |
| SetChatTitle | Changes the chat title. Supported only for basic groups, supergroups and channels. Requires can_change_info rights. The title will not be changed until the request to the server has been completed |
| SetCustomLanguagePack | Adds or changes a custom local language pack to the current localization target |
| SetCustomLanguagePackString | Adds, edits or deletes a string in a custom local language pack. Can be called before authorization |
| SetDatabaseEncryptionKey | Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain |
| SetFileGenerationProgress | Informs TDLib on a file generation prograss |
| SetGameScore | Updates the game score of the specified user in the game; for bots only |
| SetInlineGameScore | Updates the game score of the specified user in a game; for bots only |
| SetLogStream | Sets new log stream for internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously |
| SetLogTagVerbosityLevel | Sets the verbosity level for a specified TDLib internal log tag. This is an offline method. Can be called before authorization. Can be called synchronously |
| SetLogVerbosityLevel | Sets the verbosity level of the internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously |
| SetName | Changes the first and last name of the current user. If something changes, updateUser will be sent |
| SetNetworkType | 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 |
| SetOption | 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 |
| SetPassportElement | 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 |
| SetPassportElementErrors | Informs the user that some of the elements in their Telegram Passport contain errors; for bots only. The user will not be able to resend the elements, until the errors are fixed |
| SetPassword | 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 |
| SetPinnedChats | Changes the order of pinned chats |
| SetPollAnswer | Changes user answer to a poll |
| SetProfilePhoto | Uploads a new profile photo for the current user. If something changes, updateUser will be sent |
| SetRecoveryEmailAddress | Changes the 2-step verification recovery email address of 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. If new_recovery_email_address is the same as the email address that is currently set up, this call succeeds immediately and aborts all other requests waiting for an email confirmation |
| SetScopeNotificationSettings | Changes notification settings for chats of a given type |
| SetStickerPositionInSet | 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 |
| SetSupergroupStickerSet | Changes the sticker set of a supergroup; requires can_change_info rights |
| SetSupergroupUsername | Changes the username of a supergroup or channel, requires owner privileges in the supergroup or channel |
| SetTdlibParameters | Sets the parameters for TDLib initialization. Works only when the current authorization state is authorizationStateWaitTdlibParameters |
| SetUserPrivacySettingRules | Changes user privacy settings |
| SetUsername | Changes the username of the current user. If something changes, updateUser will be sent |
| SharePhoneNumber | Shares a phone number of the current user with a mutual contact. Supposed to be called when the user clicks on chatActionBarSharePhoneNumber |
| ShippingOption | One shipping option |
| Sticker | Describes a sticker |
| StickerSet | Represents a sticker set |
| StickerSetInfo | Represents short information about a sticker set |
| StickerSets | Represents a list of sticker sets |
| Stickers | Represents a list of stickers |
| StopPoll | Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag set |
| StorageStatistics | Contains the exact storage usage statistics split by chats and file type |
| StorageStatisticsByChat | Contains the storage usage statistics for a specific chat |
| StorageStatisticsByFileType | Contains the storage usage statistics for a specific file type |
| StorageStatisticsFast | Contains approximate storage usage statistics, excluding files of unknown file type |
| Supergroup | 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 |
| SupergroupFullInfo | Contains full information about a supergroup or channel |
| SupergroupMembersFilterAdministrators | Returns the owner and administrators |
| SupergroupMembersFilterBanned | Returns users banned from the supergroup or channel; can be used only by administrators |
| SupergroupMembersFilterBots | Returns bot members of the supergroup or channel |
| SupergroupMembersFilterContacts | Returns contacts of the user, which are members of the supergroup or channel |
| SupergroupMembersFilterRecent | Returns recently active users in reverse chronological order |
| SupergroupMembersFilterRestricted | Returns restricted supergroup members; can be used only by administrators |
| SupergroupMembersFilterSearch | Used to search for supergroup or channel members via a (string) query |
| SynchronizeLanguagePack | Fetches the latest versions of all strings from a language pack in the current localization target from the server. This method doesn't need to be called explicitly for the current used/base language packs. Can be called before authorization |
| TMeUrl | Represents a URL linking to an internal Telegram entity |
| TMeUrlTypeChatInvite | A chat invite link |
| TMeUrlTypeStickerSet | A URL linking to a sticker set |
| TMeUrlTypeSupergroup | A URL linking to a public supergroup or channel |
| TMeUrlTypeUser | A URL linking to a user |
| TMeUrls | Contains a list of t.me URLs |
| TdlibParameters | Contains parameters for TDLib initialization |
| TemporaryPasswordState | Returns information about the availability of a temporary password, which can be used for payments |
| TerminateAllOtherSessions | Terminates all other sessions of the current user |
| TerminateSession | Terminates a session of the current user |
| TermsOfService | Contains Telegram terms of service |
| TestBytes | A simple object containing a sequence of bytes; for testing only |
| TestCallBytes | Returns the received bytes; for testing only. This is an offline method. Can be called before authorization |
| TestCallEmpty | Does nothing; for testing only. This is an offline method. Can be called before authorization |
| TestCallString | Returns the received string; for testing only. This is an offline method. Can be called before authorization |
| TestCallVectorInt | Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization |
| TestCallVectorIntObject | Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization |
| TestCallVectorString | Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization |
| TestCallVectorStringObject | Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization |
| TestGetDifference | Forces an updates.getDifference call to the Telegram servers; for testing only |
| TestInt | A simple object containing a number; for testing only |
| TestNetwork | Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization |
| TestProxy | Sends a simple network request to the Telegram servers via proxy; for testing only. Can be called before authorization |
| TestReturnError | Returns the specified error and ensures that the Error object is used; for testing only. This is an offline method. Can be called before authorization. Can be called synchronously |
| TestSquareInt | Returns the squared received number; for testing only. This is an offline method. Can be called before authorization |
| TestString | A simple object containing a string; for testing only |
| TestUseUpdate | Does nothing and ensures that the Update object is used; for testing only. This is an offline method. Can be called before authorization |
| TestVectorInt | A simple object containing a vector of numbers; for testing only |
| TestVectorIntObject | A simple object containing a vector of objects that hold a number; for testing only |
| TestVectorString | A simple object containing a vector of strings; for testing only |
| TestVectorStringObject | A simple object containing a vector of objects that hold a string; for testing only |
| Text | Contains some text |
| TextEntities | Contains a list of text entities |
| TextEntity | Represents a part of the text that needs to be formatted in some unusual way |
| TextEntityTypeBold | A bold text |
| TextEntityTypeBotCommand | A bot command, beginning with "/". This shouldn't be highlighted if there are no bots in the chat |
| TextEntityTypeCashtag | A cashtag text, beginning with "$" and consisting of capital english letters (i.e. "$USD") |
| TextEntityTypeCode | Text that must be formatted as if inside a code HTML tag |
| TextEntityTypeEmailAddress | An email address |
| TextEntityTypeHashtag | A hashtag text, beginning with "#" |
| TextEntityTypeItalic | An italic text |
| TextEntityTypeMention | A mention of a user by their username |
| TextEntityTypeMentionName | A text shows instead of a raw mention of the user (e.g., when the user has no username) |
| TextEntityTypePhoneNumber | A phone number |
| TextEntityTypePre | Text that must be formatted as if inside a pre HTML tag |
| TextEntityTypePreCode | Text that must be formatted as if inside pre, and code HTML tags |
| TextEntityTypeStrikethrough | A strikethrough text |
| TextEntityTypeTextUrl | A text description shown instead of a raw URL |
| TextEntityTypeUnderline | An underlined text |
| TextEntityTypeUrl | An HTTP URL |
| TextParseModeHTML | The text should be parsed in HTML-style |
| TextParseModeMarkdown | The text should be parsed in markdown-style |
| ToggleChatDefaultDisableNotification | Changes the value of the default disable_notification parameter, used when a message is sent to a chat |
| ToggleChatIsMarkedAsUnread | Changes the marked as unread state of a chat |
| ToggleChatIsPinned | Changes the pinned state of a chat. You can pin up to GetOption("pinned_chat_count_max")/GetOption("pinned_archived_chat_count_max") non-secret chats and the same number of secret chats in the main/archive chat list |
| ToggleSupergroupIsAllHistoryAvailable | Toggles whether the message history of a supergroup is available to new members; requires can_change_info rights |
| ToggleSupergroupSignMessages | Toggles sender signatures messages sent in a channel; requires can_change_info rights |
| TonLiteServerResponse | Contains the response of a request to TON lite server |
| TonWalletPasswordSalt | Contains the salt to be used with locally stored password to access a local TON-based wallet |
| TopChatCategoryBots | A category containing frequently used private chats with bot users |
| TopChatCategoryCalls | A category containing frequently used chats used for calls |
| TopChatCategoryChannels | A category containing frequently used channels |
| TopChatCategoryForwardChats | A category containing frequently used chats used to forward messages |
| TopChatCategoryGroups | A category containing frequently used basic groups and supergroups |
| TopChatCategoryInlineBots | A category containing frequently used chats with inline bots sorted by their usage in inline mode |
| TopChatCategoryUsers | A category containing frequently used private chats with non-bot users |
| TransferChatOwnership | 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 |
| UnblockUser | Removes a user from the blacklist |
| UnpinChatMessage | Removes the pinned message from a chat; requires can_pin_messages rights in the group or channel |
| UpdateActiveNotifications | Contains active notifications that was shown on previous application launches. This update is sent only if a message database is used. In that case it comes once before any updateNotification and updateNotificationGroup update |
| UpdateAuthorizationState | The user authorization state has changed |
| UpdateBasicGroup | Some data of a basic group has changed. This update is guaranteed to come before the basic group identifier is returned to the client |
| UpdateBasicGroupFullInfo | Some data from basicGroupFullInfo has been changed |
| UpdateCall | New call was created or information about a call was updated |
| UpdateChatActionBar | The chat action bar was changed |
| UpdateChatChatList | The list to which the chat belongs was changed. This update is guaranteed to be sent only when chat.order == 0 and the current or the new chat list is null |
| UpdateChatDefaultDisableNotification | The value of the default disable_notification parameter, used when a message is sent to the chat, was changed |
| UpdateChatDraftMessage | 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 |
| UpdateChatHasScheduledMessages | A chat's has_scheduled_messages field has changed |
| UpdateChatIsMarkedAsUnread | A chat was marked as unread or was read |
| UpdateChatIsPinned | A chat was pinned or unpinned |
| UpdateChatIsSponsored | A chat's is_sponsored field has changed |
| UpdateChatLastMessage | The last message of a chat was changed. If last_message is null, then the last message in the chat became unknown. Some new unknown messages might be added to the chat in this case |
| UpdateChatNotificationSettings | Notification settings for a chat were changed |
| UpdateChatOnlineMemberCount | 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 |
| UpdateChatOrder | The order of the chat in the chat list has changed. Instead of this update updateChatLastMessage, updateChatIsPinned, updateChatDraftMessage, or updateChatIsSponsored might be sent |
| UpdateChatPermissions | Chat permissions was changed |
| UpdateChatPhoto | A chat photo was changed |
| UpdateChatPinnedMessage | The chat pinned message was changed |
| UpdateChatReadInbox | Incoming messages were read or number of unread messages has been changed |
| UpdateChatReadOutbox | Outgoing messages were read |
| UpdateChatReplyMarkup | The default chat reply markup was changed. Can occur because new messages with reply markup were received or because an old reply markup was hidden by the user |
| UpdateChatTitle | The title of a chat was changed |
| UpdateChatUnreadMentionCount | The chat unread_mention_count has changed |
| UpdateConnectionState | The connection state has changed |
| UpdateDeleteMessages | Some messages were deleted |
| UpdateFavoriteStickers | The list of favorite stickers was updated |
| UpdateFile | Information about a file was updated |
| UpdateFileGenerationStart | The file generation process needs to be started by the client |
| UpdateFileGenerationStop | File generation is no longer needed |
| UpdateHavePendingNotifications | Describes whether there are some pending notification updates. Can be used to prevent application from killing, while there are some pending notifications |
| UpdateInstalledStickerSets | The list of installed sticker sets was updated |
| UpdateLanguagePackStrings | Some language pack strings have been updated |
| UpdateMessageContent | The message content has changed |
| UpdateMessageContentOpened | The message content was opened. Updates voice note messages to "listened", video note messages to "viewed" and starts the TTL timer for self-destructing messages |
| UpdateMessageEdited | A message was edited. Changes in the message content will come in a separate updateMessageContent |
| UpdateMessageLiveLocationViewed | A message with a live location was viewed. When the update is received, the client is supposed to update the live location |
| UpdateMessageMentionRead | A message with an unread mention was read |
| UpdateMessageSendAcknowledged | A request to send a message has reached the Telegram server. This doesn't mean that the message will be sent successfully or even that the send message request will be processed. This update will be sent only if the option "use_quick_ack" is set to true. This update may be sent multiple times for the same message |
| UpdateMessageSendFailed | A message failed to send. Be aware that some messages being sent can be irrecoverably deleted, in which case updateDeleteMessages will be received instead of this update |
| UpdateMessageSendSucceeded | A message has been successfully sent |
| UpdateMessageViews | The view count of the message has changed |
| UpdateNewCallbackQuery | A new incoming callback query; for bots only |
| UpdateNewChat | A new chat has been loaded/created. This update is guaranteed to come before the chat identifier is returned to the client. The chat field changes will be reported through separate updates |
| UpdateNewChosenInlineResult | The user has chosen a result of an inline query; for bots only |
| UpdateNewCustomEvent | A new incoming event; for bots only |
| UpdateNewCustomQuery | A new incoming query; for bots only |
| UpdateNewInlineCallbackQuery | A new incoming callback query from a message sent via a bot; for bots only |
| UpdateNewInlineQuery | A new incoming inline query; for bots only |
| UpdateNewMessage | A new message was received; can also be an outgoing message |
| UpdateNewPreCheckoutQuery | A new incoming pre-checkout query; for bots only. Contains full information about a checkout |
| UpdateNewShippingQuery | A new incoming shipping query; for bots only. Only for invoices with flexible price |
| UpdateNotification | A notification was changed |
| UpdateNotificationGroup | A list of active notifications in a notification group has changed |
| UpdateOption | An option changed its value |
| UpdatePoll | Information about a poll was updated; for bots only |
| UpdateRecentStickers | The list of recently used stickers was updated |
| UpdateSavedAnimations | The list of saved animations was updated |
| UpdateScopeNotificationSettings | Notification settings for some type of chats were updated |
| UpdateSecretChat | Some data of a secret chat has changed. This update is guaranteed to come before the secret chat identifier is returned to the client |
| UpdateSelectedBackground | The selected background has changed |
| UpdateServiceNotification | Service notification from the server. Upon receiving this the client must show a popup with the content of the notification |
| UpdateSupergroup | Some data of a supergroup or a channel has changed. This update is guaranteed to come before the supergroup identifier is returned to the client |
| UpdateSupergroupFullInfo | Some data from supergroupFullInfo has been changed |
| UpdateTermsOfService | 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" |
| UpdateTrendingStickerSets | The list of trending sticker sets was updated or some of them were viewed |
| UpdateUnreadChatCount | Number of unread chats, i.e. with unread messages or marked as unread, has changed. This update is sent only if a message database is used |
| UpdateUnreadMessageCount | Number of unread messages in a chat list has changed. This update is sent only if a message database is used |
| UpdateUser | Some data of a user has changed. This update is guaranteed to come before the user identifier is returned to the client |
| UpdateUserChatAction | User activity in the chat has changed |
| UpdateUserFullInfo | Some data from userFullInfo has been changed |
| UpdateUserPrivacySettingRules | Some privacy setting rules have been changed |
| UpdateUserStatus | The user went online or offline |
| UpdateUsersNearby | List of users nearby has changed. The update is sent only 60 seconds after a successful searchChatsNearby request |
| Updates | Contains a list of updates |
| UpgradeBasicGroupChatToSupergroupChat | Creates a new supergroup from an existing basic group and sends a corresponding messageChatUpgradeTo and messageChatUpgradeFrom; requires creator privileges. Deactivates the original basic group |
| UploadFile | 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 |
| UploadStickerFile | Uploads a PNG image with a sticker; for bots only; returns the uploaded file |
| User | Represents a user |
| UserFullInfo | Contains full information about a user (except the full list of profile photos) |
| UserPrivacySettingAllowCalls | A privacy setting for managing whether the user can be called |
| UserPrivacySettingAllowChatInvites | A privacy setting for managing whether the user can be invited to chats |
| UserPrivacySettingAllowFindingByPhoneNumber | A privacy setting for managing whether the user can be found by its phone number. Checked only if the phone number is not known to the other user. Can be set only to "Allow contacts" or "Allow all" |
| UserPrivacySettingAllowPeerToPeerCalls | A privacy setting for managing whether peer-to-peer connections can be used for calls |
| UserPrivacySettingRuleAllowAll | A rule to allow all users to do something |
| UserPrivacySettingRuleAllowChatMembers | A rule to allow all members of certain specified basic groups and supergroups to doing something |
| UserPrivacySettingRuleAllowContacts | A rule to allow all of a user's contacts to do something |
| UserPrivacySettingRuleAllowUsers | A rule to allow certain specified users to do something |
| UserPrivacySettingRuleRestrictAll | A rule to restrict all users from doing something |
| UserPrivacySettingRuleRestrictChatMembers | A rule to restrict all members of specified basic groups and supergroups from doing something |
| UserPrivacySettingRuleRestrictContacts | A rule to restrict all contacts of a user from doing something |
| UserPrivacySettingRuleRestrictUsers | A rule to restrict all specified users from doing something |
| UserPrivacySettingRules | A list of privacy rules. Rules are matched in the specified order. The first matched rule defines the privacy setting for a given user. If no rule matches, the action is not allowed |
| UserPrivacySettingShowLinkInForwardedMessages | A privacy setting for managing whether a link to the user's account is included in forwarded messages |
| UserPrivacySettingShowPhoneNumber | A privacy setting for managing whether the user's phone number is visible |
| UserPrivacySettingShowProfilePhoto | A privacy setting for managing whether the user's profile photo is visible |
| UserPrivacySettingShowStatus | A privacy setting for managing whether the user's online status is visible |
| UserProfilePhoto | Contains full information about a user profile photo |
| UserProfilePhotos | Contains part of the list of user photos |
| UserStatusEmpty | The user status was never changed |
| UserStatusLastMonth | The user is offline, but was online last month |
| UserStatusLastWeek | The user is offline, but was online last week |
| UserStatusOffline | The user is offline |
| UserStatusOnline | The user is online |
| UserStatusRecently | The user was online recently |
| UserTypeBot | A bot (see https://core.telegram.org/bots) |
| UserTypeDeleted | A deleted user or deleted bot. No information on the user besides the user identifier is available. It is not possible to perform any active actions on this type of user |
| UserTypeRegular | A regular user |
| UserTypeUnknown | No information on the user besides the user identifier is available, yet this user has not been deleted. This object is extremely rare and must be handled like a deleted user. It is not possible to perform any actions on users of this type |
| Users | Represents a list of users |
| ValidateOrderInfo | Validates the order information provided by a user and returns the available shipping options for a flexible invoice |
| ValidatedOrderInfo | Contains a temporary identifier of validated order information, which is stored for one hour. Also contains the available shipping options |
| Venue | Describes a venue |
| Video | Describes a video file |
| VideoNote | Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format |
| ViewMessages | 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) |
| ViewTrendingStickerSets | Informs the server that some trending sticker sets have been viewed by the user |
| VoiceNote | Describes a voice note. The voice note must be encoded with the Opus codec, and stored inside an OGG container. Voice notes can have only a single audio channel |
| WebPage | Describes a web page preview |
| WebPageInstantView | Describes an instant view page for a web page |
| WriteGeneratedFilePart | Writes a part of a generated file. This method is intended to be used only if the client has no direct access to TDLib's file system, because it is usually slower than a direct write to the destination file |
Enums
| AuthenticationCodeType | Provides information about the method by which an authentication code is delivered to the user |
| AuthorizationState | Represents the current authorization state of the client |
| BackgroundFill | Describes a fill of a background |
| BackgroundType | Describes a type of a background |
| CallDiscardReason | Describes the reason why a call was discarded |
| CallProblem | Describes the exact type of a problem with a call |
| CallState | Describes the current call state |
| CallbackQueryPayload | Represents a payload of a callback query |
| CanTransferOwnershipResult | Represents result of checking whether the current session can be used to transfer a chat ownership to another user |
| ChatAction | Describes the different types of activity in a chat |
| ChatActionBar | Describes actions which should be possible to do through a chat action bar |
| ChatEventAction | Represents a chat event |
| ChatList | Describes a list of chats |
| ChatMemberStatus | Provides information about the status of a member in a chat |
| ChatMembersFilter | Specifies the kind of chat members to return in searchChatMembers |
| ChatReportReason | Describes the reason why a chat is reported |
| ChatType | Describes the type of a chat |
| CheckChatUsernameResult | Represents result of checking whether a username can be set for a chat |
| ConnectionState | Describes the current state of the connection to Telegram servers |
| DeviceToken | Represents a data needed to subscribe for push notifications through registerDevice method. To use specific push notification service, you must specify the correct application platform and upload valid server authentication data at https://my.telegram.org |
| FileType | Represents the type of a file |
| InlineKeyboardButtonType | Describes the type of an inline keyboard button |
| InlineQueryResult | Represents a single result of an inline query |
| InputBackground | Contains information about background to set |
| InputCredentials | Contains information about the payment method chosen by the user |
| InputFile | Points to a file |
| InputInlineQueryResult | Represents a single result of an inline query; for bots only |
| InputMessageContent | The content of a message to send |
| InputPassportElement | Contains information about a Telegram Passport element to be saved |
| InputPassportElementErrorSource | Contains the description of an error in a Telegram Passport element; for bots only |
| JsonValue | Represents a JSON value |
| KeyboardButtonType | Describes a keyboard button type |
| LanguagePackStringValue | Represents the value of a string in a language pack |
| LogStream | Describes a stream to which TDLib internal log is written |
| LoginUrlInfo | Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl |
| MaskPoint | Part of the face, relative to which a mask should be placed |
| MessageContent | Contains the content of a message |
| MessageForwardOrigin | Contains information about the origin of a forwarded message |
| MessageSchedulingState | Contains information about the time when a scheduled message will be sent |
| MessageSendingState | Contains information about the sending state of the message |
| NetworkStatisticsEntry | Contains statistics about network usage |
| NetworkType | Represents the type of a network |
| NotificationGroupType | Describes type of notifications in the group |
| NotificationSettingsScope | Describes the types of chats to which notification settings are applied |
| NotificationType | Contains detailed information about a notification |
| OptionValue | Represents the value of an option |
| PageBlock | Describes a block of an instant view web page |
| PageBlockHorizontalAlignment | Describes a horizontal alignment of a table cell content |
| PageBlockVerticalAlignment | Describes a Vertical alignment of a table cell content |
| PassportElement | Contains information about a Telegram Passport element |
| PassportElementErrorSource | Contains the description of an error in a Telegram Passport element |
| PassportElementType | Contains the type of a Telegram Passport element |
| ProxyType | Describes the type of the proxy server |
| PublicChatType | Describes a type of public chats |
| PushMessageContent | Contains content of a push message notification |
| ReplyMarkup | Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots |
| RichText | Describes a text object inside an instant-view web page |
| SearchMessagesFilter | Represents a filter for message search results |
| SecretChatState | Describes the current secret chat state |
| SupergroupMembersFilter | Specifies the kind of chat members to return in getSupergroupMembers |
| TMeUrlType | Describes the type of a URL linking to an internal Telegram entity |
| TextEntityType | Represents a part of the text which must be formatted differently |
| TextParseMode | Describes the way the text should be parsed for TextEntities |
| TopChatCategory | Represents the categories of chats for which a list of frequently used chats can be retrieved |
| Update | Contains notifications about data changes |
| UserPrivacySetting | Describes available user privacy settings |
| UserPrivacySettingRule | Represents a single rule for managing privacy settings |
| UserStatus | Describes the last time the user was online |
| UserType | Represents the type of the user. The following types are possible: regular users, deleted users and bots |
Traits
| RFunction | |
| RObject | All tdlib type abstract class defined the same behavior |
| TDAuthenticationCodeType | TRAIT | Provides information about the method by which an authentication code is delivered to the user |
| TDAuthorizationState | TRAIT | Represents the current authorization state of the client |
| TDBackgroundFill | TRAIT | Describes a fill of a background |
| TDBackgroundType | TRAIT | Describes a type of a background |
| TDCallDiscardReason | TRAIT | Describes the reason why a call was discarded |
| TDCallProblem | TRAIT | Describes the exact type of a problem with a call |
| TDCallState | TRAIT | Describes the current call state |
| TDCallbackQueryPayload | TRAIT | Represents a payload of a callback query |
| TDCanTransferOwnershipResult | TRAIT | Represents result of checking whether the current session can be used to transfer a chat ownership to another user |
| TDChatAction | TRAIT | Describes the different types of activity in a chat |
| TDChatActionBar | TRAIT | Describes actions which should be possible to do through a chat action bar |
| TDChatEventAction | TRAIT | Represents a chat event |
| TDChatList | TRAIT | Describes a list of chats |
| TDChatMemberStatus | TRAIT | Provides information about the status of a member in a chat |
| TDChatMembersFilter | TRAIT | Specifies the kind of chat members to return in searchChatMembers |
| TDChatReportReason | TRAIT | Describes the reason why a chat is reported |
| TDChatType | TRAIT | Describes the type of a chat |
| TDCheckChatUsernameResult | TRAIT | Represents result of checking whether a username can be set for a chat |
| TDConnectionState | TRAIT | Describes the current state of the connection to Telegram servers |
| TDDeviceToken | TRAIT | Represents a data needed to subscribe for push notifications through registerDevice method. To use specific push notification service, you must specify the correct application platform and upload valid server authentication data at https://my.telegram.org |
| TDFileType | TRAIT | Represents the type of a file |
| TDInlineKeyboardButtonType | TRAIT | Describes the type of an inline keyboard button |
| TDInlineQueryResult | TRAIT | Represents a single result of an inline query |
| TDInputBackground | TRAIT | Contains information about background to set |
| TDInputCredentials | TRAIT | Contains information about the payment method chosen by the user |
| TDInputFile | TRAIT | Points to a file |
| TDInputInlineQueryResult | TRAIT | Represents a single result of an inline query; for bots only |
| TDInputMessageContent | TRAIT | The content of a message to send |
| TDInputPassportElement | TRAIT | Contains information about a Telegram Passport element to be saved |
| TDInputPassportElementErrorSource | TRAIT | Contains the description of an error in a Telegram Passport element; for bots only |
| TDJsonValue | TRAIT | Represents a JSON value |
| TDKeyboardButtonType | TRAIT | Describes a keyboard button type |
| TDLanguagePackStringValue | TRAIT | Represents the value of a string in a language pack |
| TDLogStream | TRAIT | Describes a stream to which TDLib internal log is written |
| TDLoginUrlInfo | TRAIT | Contains information about an inline button of type inlineKeyboardButtonTypeLoginUrl |
| TDMaskPoint | TRAIT | Part of the face, relative to which a mask should be placed |
| TDMessageContent | TRAIT | Contains the content of a message |
| TDMessageForwardOrigin | TRAIT | Contains information about the origin of a forwarded message |
| TDMessageSchedulingState | TRAIT | Contains information about the time when a scheduled message will be sent |
| TDMessageSendingState | TRAIT | Contains information about the sending state of the message |
| TDNetworkStatisticsEntry | TRAIT | Contains statistics about network usage |
| TDNetworkType | TRAIT | Represents the type of a network |
| TDNotificationGroupType | TRAIT | Describes type of notifications in the group |
| TDNotificationSettingsScope | TRAIT | Describes the types of chats to which notification settings are applied |
| TDNotificationType | TRAIT | Contains detailed information about a notification |
| TDOptionValue | TRAIT | Represents the value of an option |
| TDPageBlock | TRAIT | Describes a block of an instant view web page |
| TDPageBlockHorizontalAlignment | TRAIT | Describes a horizontal alignment of a table cell content |
| TDPageBlockVerticalAlignment | TRAIT | Describes a Vertical alignment of a table cell content |
| TDPassportElement | TRAIT | Contains information about a Telegram Passport element |
| TDPassportElementErrorSource | TRAIT | Contains the description of an error in a Telegram Passport element |
| TDPassportElementType | TRAIT | Contains the type of a Telegram Passport element |
| TDProxyType | TRAIT | Describes the type of the proxy server |
| TDPublicChatType | TRAIT | Describes a type of public chats |
| TDPushMessageContent | TRAIT | Contains content of a push message notification |
| TDReplyMarkup | TRAIT | Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots |
| TDRichText | TRAIT | Describes a text object inside an instant-view web page |
| TDSearchMessagesFilter | TRAIT | Represents a filter for message search results |
| TDSecretChatState | TRAIT | Describes the current secret chat state |
| TDSupergroupMembersFilter | TRAIT | Specifies the kind of chat members to return in getSupergroupMembers |
| TDTMeUrlType | TRAIT | Describes the type of a URL linking to an internal Telegram entity |
| TDTextEntityType | TRAIT | Represents a part of the text which must be formatted differently |
| TDTextParseMode | TRAIT | Describes the way the text should be parsed for TextEntities |
| TDTopChatCategory | TRAIT | Represents the categories of chats for which a list of frequently used chats can be retrieved |
| TDUpdate | TRAIT | Contains notifications about data changes |
| TDUserPrivacySetting | TRAIT | Describes available user privacy settings |
| TDUserPrivacySettingRule | TRAIT | Represents a single rule for managing privacy settings |
| TDUserStatus | TRAIT | Describes the last time the user was online |
| TDUserType | TRAIT | Represents the type of the user. The following types are possible: regular users, deleted users and bots |
Functions
| detect_td_type | |
| from_json |