[][src]Module rtdlib::types

Structs

AcceptCall

Accepts an incoming call.

AcceptCallBuilder
AcceptTermsOfService

Accepts Telegram terms of services.

AcceptTermsOfServiceBuilder
AccountTtl

Contains information about the period of inactivity after which the current user's account will automatically be deleted.

AccountTtlBuilder
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.

AddChatMemberBuilder
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.

AddChatMembersBuilder
AddCustomServerLanguagePack

Adds a custom server language pack to the list of installed language packs in current localization target. Can be called before authorization.

AddCustomServerLanguagePackBuilder
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.

AddFavoriteStickerBuilder
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.

AddLocalMessageBuilder
AddLogMessage

Adds a message to TDLib internal log. This is an offline method. Can be called before authorization. Can be called synchronously.

AddLogMessageBuilder
AddNetworkStatistics

Adds the specified data to data usage statistics. Can be called before authorization.

AddNetworkStatisticsBuilder
AddProxy

Adds a proxy server for network requests. Can be called before authorization.

AddProxyBuilder
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.

AddRecentStickerBuilder
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.

AddRecentlyFoundChatBuilder
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.

AddSavedAnimationBuilder
AddStickerToSet

Adds a new sticker to a set; for bots only. Returns the sticker set.

AddStickerToSetBuilder
Address

Describes an address.

AddressBuilder
Animation

Describes an animation file. The animation must be encoded in GIF or MPEG4 format.

AnimationBuilder
Animations

Represents a list of animations.

AnimationsBuilder
AnswerCallbackQuery

Sets the result of a callback query; for bots only.

AnswerCallbackQueryBuilder
AnswerCustomQuery

Answers a custom query; for bots only.

AnswerCustomQueryBuilder
AnswerInlineQuery

Sets the result of an inline query; for bots only.

AnswerInlineQueryBuilder
AnswerPreCheckoutQuery

Sets the result of a pre-checkout query; for bots only.

AnswerPreCheckoutQueryBuilder
AnswerShippingQuery

Sets the result of a shipping query; for bots only.

AnswerShippingQueryBuilder
Audio

Describes an audio file. Audio is usually in MP3 format.

AudioBuilder
AuthenticationCodeInfo

Information about the authentication code that was sent.

AuthenticationCodeInfoBuilder
AuthenticationCodeTypeCall

An authentication code is delivered via a phone call to the specified phone number.

AuthenticationCodeTypeCallBuilder
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.

AuthenticationCodeTypeFlashCallBuilder
AuthenticationCodeTypeSms

An authentication code is delivered via an SMS message to the specified phone number.

AuthenticationCodeTypeSmsBuilder
AuthenticationCodeTypeTelegramMessage

An authentication code is delivered via a private Telegram message, which can be viewed in another client.

AuthenticationCodeTypeTelegramMessageBuilder
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

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 finalize authorization.

AuthorizationStateWaitEncryptionKey

TDLib needs an encryption key to decrypt the local database.

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.

AuthorizationStateWaitTdlibParameters

TDLib needs TdlibParameters for initialization.

BasicGroup

Represents a basic group of 0-200 users (must be upgraded to a supergroup to accommodate more than 200 users).

BasicGroupBuilder
BasicGroupFullInfo

Contains full information about a basic group.

BasicGroupFullInfoBuilder
BlockUser

Adds a user to the blacklist.

BlockUserBuilder
BotCommand

Represents commands supported by a bot.

BotCommandBuilder
BotInfo

Provides information about a bot and its supported commands.

BotInfoBuilder
Call

Describes a call.

CallBuilder
CallConnection

Describes the address of UDP reflectors.

CallConnectionBuilder
CallDiscardReasonDeclined

The call was ended before the conversation started. It was declined by the other party.

CallDiscardReasonDeclinedBuilder
CallDiscardReasonDisconnected

The call was ended during the conversation because the users were disconnected.

CallDiscardReasonDisconnectedBuilder
CallDiscardReasonEmpty

The call wasn't discarded, or the reason is unknown.

CallDiscardReasonEmptyBuilder
CallDiscardReasonHungUp

The call was ended because one of the parties hung up.

CallDiscardReasonHungUpBuilder
CallDiscardReasonMissed

The call was ended before the conversation started. It was cancelled by the caller or missed by the other party.

CallDiscardReasonMissedBuilder
CallId

Contains the call identifier.

CallIdBuilder
CallProtocol

Specifies the supported call protocols.

CallProtocolBuilder
CallStateDiscarded

The call has ended successfully.

CallStateDiscardedBuilder
CallStateError

The call has ended with an error.

CallStateErrorBuilder
CallStateExchangingKeys

The call has been answered and encryption keys are being exchanged.

CallStateExchangingKeysBuilder
CallStateHangingUp

The call is hanging up after

CallStateHangingUpBuilder
CallStatePending

The call is pending, waiting to be accepted by a user.

CallStatePendingBuilder
CallStateReady

The call is ready to use.

CallStateReadyBuilder
CallbackQueryAnswer

Contains a bot's answer to a callback query.

CallbackQueryAnswerBuilder
CallbackQueryPayloadData

The payload from a general callback button.

CallbackQueryPayloadDataBuilder
CallbackQueryPayloadGame

The payload from a game callback button.

CallbackQueryPayloadGameBuilder
CancelDownloadFile

Stops the downloading of a file. If a file has already been downloaded, does nothing.

CancelDownloadFileBuilder
CancelUploadFile

Stops the uploading of a file. Supported only for files uploaded by using

CancelUploadFileBuilder
ChangeChatReportSpamState

Reports to the server whether a chat is a spam chat or not. Can be used only if ChatReportSpamState.can_report_spam is true. After this request, ChatReportSpamState.can_report_spam becomes false forever.

ChangeChatReportSpamStateBuilder
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.

ChangeImportedContactsBuilder
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.

ChangePhoneNumberBuilder
ChangeStickerSet

Installs/uninstalls or activates/archives a sticker set.

ChangeStickerSetBuilder
Chat

A chat. (Can be a private chat, basic group, supergroup, or secret chat.)

ChatActionCancel

The user has cancelled the previous action.

ChatActionCancelBuilder
ChatActionChoosingContact

The user is picking a contact to send.

ChatActionChoosingContactBuilder
ChatActionChoosingLocation

The user is picking a location or venue to send.

ChatActionChoosingLocationBuilder
ChatActionRecordingVideo

The user is recording a video.

ChatActionRecordingVideoBuilder
ChatActionRecordingVideoNote

The user is recording a video note.

ChatActionRecordingVideoNoteBuilder
ChatActionRecordingVoiceNote

The user is recording a voice note.

ChatActionRecordingVoiceNoteBuilder
ChatActionStartPlayingGame

The user has started to play a game.

ChatActionStartPlayingGameBuilder
ChatActionTyping

The user is typing a message.

ChatActionTypingBuilder
ChatActionUploadingDocument

The user is uploading a document.

ChatActionUploadingDocumentBuilder
ChatActionUploadingPhoto

The user is uploading a photo.

ChatActionUploadingPhotoBuilder
ChatActionUploadingVideo

The user is uploading a video.

ChatActionUploadingVideoBuilder
ChatActionUploadingVideoNote

The user is uploading a video note.

ChatActionUploadingVideoNoteBuilder
ChatActionUploadingVoiceNote

The user is uploading a voice note.

ChatActionUploadingVoiceNoteBuilder
ChatBuilder
ChatEvent

Represents a chat event.

ChatEventBuilder
ChatEventDescriptionChanged

The chat description was changed.

ChatEventDescriptionChangedBuilder
ChatEventInvitesToggled

The anyone_can_invite setting of a supergroup chat was toggled.

ChatEventInvitesToggledBuilder
ChatEventIsAllHistoryAvailableToggled

The is_all_history_available setting of a supergroup was toggled.

ChatEventIsAllHistoryAvailableToggledBuilder
ChatEventLogFilters

Represents a set of filters used to obtain a chat event log.

ChatEventLogFiltersBuilder
ChatEventMemberInvited

A new chat member was invited.

ChatEventMemberInvitedBuilder
ChatEventMemberJoined

A new member joined the chat.

ChatEventMemberJoinedBuilder
ChatEventMemberLeft

A member left the chat.

ChatEventMemberLeftBuilder
ChatEventMemberPromoted

A chat member has gained/lost administrator status, or the list of their administrator privileges has changed.

ChatEventMemberPromotedBuilder
ChatEventMemberRestricted

A chat member was restricted/unrestricted or banned/unbanned, or the list of their restrictions has changed.

ChatEventMemberRestrictedBuilder
ChatEventMessageDeleted

A message was deleted.

ChatEventMessageDeletedBuilder
ChatEventMessageEdited

A message was edited.

ChatEventMessageEditedBuilder
ChatEventMessagePinned

A message was pinned.

ChatEventMessagePinnedBuilder
ChatEventMessageUnpinned

A message was unpinned.

ChatEventMessageUnpinnedBuilder
ChatEventPhotoChanged

The chat photo was changed.

ChatEventPhotoChangedBuilder
ChatEventSignMessagesToggled

The sign_messages setting of a channel was toggled.

ChatEventSignMessagesToggledBuilder
ChatEventStickerSetChanged

The supergroup sticker set was changed.

ChatEventStickerSetChangedBuilder
ChatEventTitleChanged

The chat title was changed.

ChatEventTitleChangedBuilder
ChatEventUsernameChanged

The chat username was changed.

ChatEventUsernameChangedBuilder
ChatEvents

Contains a list of chat events.

ChatEventsBuilder
ChatInviteLink

Contains a chat invite link.

ChatInviteLinkBuilder
ChatInviteLinkInfo

Contains information about a chat invite link.

ChatInviteLinkInfoBuilder
ChatMember

A user with information about joining/leaving a chat.

ChatMemberBuilder
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.

ChatMemberStatusAdministratorBuilder
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.

ChatMemberStatusBannedBuilder
ChatMemberStatusCreator

The user is the creator of a chat and has all the administrator privileges.

ChatMemberStatusCreatorBuilder
ChatMemberStatusLeft

The user is not a chat member.

ChatMemberStatusLeftBuilder
ChatMemberStatusMember

The user is a member of a chat, without any additional privileges or restrictions.

ChatMemberStatusMemberBuilder
ChatMemberStatusRestricted

The user is under certain restrictions in the chat. Not supported in basic groups and channels.

ChatMemberStatusRestrictedBuilder
ChatMembers

Contains a list of chat members.

ChatMembersBuilder
ChatMembersFilterAdministrators

Returns the creator and administrators.

ChatMembersFilterAdministratorsBuilder
ChatMembersFilterBanned

Returns users banned from the chat; can be used only by administrators in a supergroup or in a channel.

ChatMembersFilterBannedBuilder
ChatMembersFilterBots

Returns bot members of the chat.

ChatMembersFilterBotsBuilder
ChatMembersFilterMembers

Returns all chat members, including restricted chat members.

ChatMembersFilterMembersBuilder
ChatMembersFilterRestricted

Returns users under certain restrictions in the chat; can be used only by administrators in a supergroup.

ChatMembersFilterRestrictedBuilder
ChatNotificationSettings

Contains information about notification settings for a chat.

ChatNotificationSettingsBuilder
ChatPhoto

Describes the photo of a chat.

ChatPhotoBuilder
ChatReportReasonChildAbuse

The chat has child abuse related content.

ChatReportReasonChildAbuseBuilder
ChatReportReasonCopyright

The chat contains copyrighted content.

ChatReportReasonCopyrightBuilder
ChatReportReasonCustom

A custom reason provided by the user.

ChatReportReasonCustomBuilder
ChatReportReasonPornography

The chat contains pornographic messages.

ChatReportReasonPornographyBuilder
ChatReportReasonSpam

The chat contains spam messages.

ChatReportReasonSpamBuilder
ChatReportReasonViolence

The chat promotes violence.

ChatReportReasonViolenceBuilder
ChatReportSpamState

Contains information about the availability of the "Report spam" action for a chat.

ChatReportSpamStateBuilder
ChatTypeBasicGroup

A basic group (i.e., a chat with 0-200 other users).

ChatTypeBasicGroupBuilder
ChatTypePrivate

An ordinary chat with a user.

ChatTypePrivateBuilder
ChatTypeSecret

A secret chat with a user.

ChatTypeSecretBuilder
ChatTypeSupergroup

A supergroup (i.e. a chat with up to GetOption("supergroup_max_size") other users), or channel (with unlimited members).

ChatTypeSupergroupBuilder
Chats

Represents a list of chats.

ChatsBuilder
CheckAuthenticationBotToken

Checks the authentication token of a bot; to log in as a bot. Works only when the current authorization state is

CheckAuthenticationBotTokenBuilder
CheckAuthenticationCode

Checks the authentication code. Works only when the current authorization state is

CheckAuthenticationCodeBuilder
CheckAuthenticationPassword

Checks the authentication password for correctness. Works only when the current authorization state is

CheckAuthenticationPasswordBuilder
CheckChangePhoneNumberCode

Checks the authentication code sent to confirm a new phone number of the user.

CheckChangePhoneNumberCodeBuilder
CheckChatInviteLink

Checks the validity of an invite link for a chat and returns information about the corresponding chat.

CheckChatInviteLinkBuilder
CheckChatUsername

Checks whether a username can be set for a chat.

CheckChatUsernameBuilder
CheckChatUsernameResultOk

The username can be set.

CheckChatUsernameResultOkBuilder
CheckChatUsernameResultPublicChatsTooMuch

The user has too much public chats, one of them should be made private first.

CheckChatUsernameResultPublicChatsTooMuchBuilder
CheckChatUsernameResultPublicGroupsUnavailable

The user can't be a member of a public supergroup.

CheckChatUsernameResultPublicGroupsUnavailableBuilder
CheckChatUsernameResultUsernameInvalid

The username is invalid.

CheckChatUsernameResultUsernameInvalidBuilder
CheckChatUsernameResultUsernameOccupied

The username is occupied.

CheckChatUsernameResultUsernameOccupiedBuilder
CheckDatabaseEncryptionKey

Checks the database encryption key for correctness. Works only when the current authorization state is

CheckDatabaseEncryptionKeyBuilder
CheckEmailAddressVerificationCode

Checks the email address verification code for Telegram Passport.

CheckEmailAddressVerificationCodeBuilder
CheckPhoneNumberConfirmationCode

Checks phone number confirmation code.

CheckPhoneNumberConfirmationCodeBuilder
CheckPhoneNumberVerificationCode

Checks the phone number verification code for Telegram Passport.

CheckPhoneNumberVerificationCodeBuilder
CheckRecoveryEmailAddressCode

Checks the 2-step verification recovery email address verification code.

CheckRecoveryEmailAddressCodeBuilder
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.

CleanFileNameBuilder
ClearAllDraftMessages

Clears draft messages in all chats.

ClearAllDraftMessagesBuilder
ClearImportedContacts

Clears all imported contacts, contact list remains unchanged.

ClearImportedContactsBuilder
ClearRecentStickers

Clears the list of recently used stickers.

ClearRecentStickersBuilder
ClearRecentlyFoundChats

Clears the list of recently found chats.

ClearRecentlyFoundChatsBuilder
Close

Closes the TDLib instance. All databases will be flushed to disk and properly closed. After the close completes,

CloseBuilder
CloseChat

Informs TDLib that the chat is closed by the user. Many useful activities depend on the chat being opened or closed.

CloseChatBuilder
CloseSecretChat

Closes a secret chat, effectively transfering its state to

CloseSecretChatBuilder
ConnectedWebsite

Contains information about one website the current user is logged in with Telegram.

ConnectedWebsiteBuilder
ConnectedWebsites

Contains a list of websites the current user is logged in with Telegram.

ConnectedWebsitesBuilder
ConnectionStateConnecting

Currently establishing a connection to the Telegram servers.

ConnectionStateConnectingBuilder
ConnectionStateConnectingToProxy

Currently establishing a connection with a proxy server.

ConnectionStateConnectingToProxyBuilder
ConnectionStateReady

There is a working connection to the Telegram servers.

ConnectionStateReadyBuilder
ConnectionStateUpdating

Downloading data received while the client was offline.

ConnectionStateUpdatingBuilder
ConnectionStateWaitingForNetwork

Currently waiting for the network to become available. Use SetNetworkType to change the available network type.

ConnectionStateWaitingForNetworkBuilder
Contact

Describes a user contact.

ContactBuilder
Count

Contains a counter.

CountBuilder
CreateBasicGroupChat

Returns an existing chat corresponding to a known basic group.

CreateBasicGroupChatBuilder
CreateCall

Creates a new call.

CreateCallBuilder
CreateNewBasicGroupChat

Creates a new basic group and sends a corresponding

CreateNewBasicGroupChatBuilder
CreateNewSecretChat

Creates a new secret chat. Returns the newly created chat.

CreateNewSecretChatBuilder
CreateNewStickerSet

Creates a new sticker set; for bots only. Returns the newly created sticker set.

CreateNewStickerSetBuilder
CreateNewSupergroupChat

Creates a new supergroup or channel and sends a corresponding

CreateNewSupergroupChatBuilder
CreatePrivateChat

Returns an existing chat corresponding to a given user.

CreatePrivateChatBuilder
CreateSecretChat

Returns an existing chat corresponding to a known secret chat.

CreateSecretChatBuilder
CreateSupergroupChat

Returns an existing chat corresponding to a known supergroup or channel.

CreateSupergroupChatBuilder
CreateTemporaryPassword

Creates a new temporary password for processing payments.

CreateTemporaryPasswordBuilder
CustomRequestResult

Contains the result of a custom request.

CustomRequestResultBuilder
DatabaseStatistics

Contains database statistics.

DatabaseStatisticsBuilder
Date

Represents a date according to the Gregorian calendar.

DateBuilder
DatedFile

File with the date it was uploaded.

DatedFileBuilder
DeepLinkInfo

Contains information about a tg:// deep link.

DeepLinkInfoBuilder
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

DeleteAccountBuilder
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.

DeleteChatHistoryBuilder
DeleteChatMessagesFromUser

Deletes all messages sent by the specified user to a chat. Supported only in supergroups; requires can_delete_messages administrator privileges.

DeleteChatMessagesFromUserBuilder
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.

DeleteChatReplyMarkupBuilder
DeleteFile

Deletes a file from the TDLib file cache.

DeleteFileBuilder
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.

DeleteLanguagePackBuilder
DeleteMessages

Deletes messages.

DeleteMessagesBuilder
DeletePassportElement

Deletes a Telegram Passport element.

DeletePassportElementBuilder
DeleteProfilePhoto

Deletes a profile photo. If something changes,

DeleteProfilePhotoBuilder
DeleteSavedCredentials

Deletes saved credentials for all payment provider bots.

DeleteSavedCredentialsBuilder
DeleteSavedOrderInfo

Deletes saved order info.

DeleteSavedOrderInfoBuilder
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 creator privileges in the supergroup or channel. Chats with more than 1000 members can't be deleted using this method.

DeleteSupergroupBuilder
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

DestroyBuilder
DeviceTokenApplePush

A token for Apple Push Notification service.

DeviceTokenApplePushBuilder
DeviceTokenApplePushVoIP

A token for Apple Push Notification service VoIP notifications.

DeviceTokenApplePushVoIPBuilder
DeviceTokenBlackBerryPush

A token for BlackBerry Push Service.

DeviceTokenBlackBerryPushBuilder
DeviceTokenFirebaseCloudMessaging

A token for Firebase Cloud Messaging.

DeviceTokenFirebaseCloudMessagingBuilder
DeviceTokenMicrosoftPush

A token for Microsoft Push Notification Service.

DeviceTokenMicrosoftPushBuilder
DeviceTokenMicrosoftPushVoIP

A token for Microsoft Push Notification Service VoIP channel.

DeviceTokenMicrosoftPushVoIPBuilder
DeviceTokenSimplePush

A token for Simple Push API for Firefox OS.

DeviceTokenSimplePushBuilder
DeviceTokenTizenPush

A token for Tizen Push Service.

DeviceTokenTizenPushBuilder
DeviceTokenUbuntuPush

A token for Ubuntu Push

DeviceTokenUbuntuPushBuilder
DeviceTokenWebPush

A token for web Push API.

DeviceTokenWebPushBuilder
DeviceTokenWindowsPush

A token for Windows Push Notification Services.

DeviceTokenWindowsPushBuilder
DisableProxy

Disables the currently enabled proxy. Can be called before authorization.

DisableProxyBuilder
DiscardCall

Discards a call.

DiscardCallBuilder
DisconnectAllWebsites

Disconnects all websites from the current user's Telegram account.

DisconnectAllWebsitesBuilder
DisconnectWebsite

Disconnects website from the current user's Telegram account.

DisconnectWebsiteBuilder
Document

Describes a document of any type.

DocumentBuilder
DownloadFile

Downloads a file from the cloud. Download progress and completion of the download will be notified through

DownloadFileBuilder
DraftMessage

Contains information about a message draft.

DraftMessageBuilder
EditCustomLanguagePackInfo

Edits information about a custom local language pack in the current localization target. Can be called before authorization.

EditCustomLanguagePackInfoBuilder
EditInlineMessageCaption

Edits the caption of an inline message sent via a bot; for bots only.

EditInlineMessageCaptionBuilder
EditInlineMessageLiveLocation

Edits the content of a live location in an inline message sent via a bot; for bots only.

EditInlineMessageLiveLocationBuilder
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.

EditInlineMessageMediaBuilder
EditInlineMessageReplyMarkup

Edits the reply markup of an inline message sent via a bot; for bots only.

EditInlineMessageReplyMarkupBuilder
EditInlineMessageText

Edits the text of an inline text or game message sent via a bot; for bots only.

EditInlineMessageTextBuilder
EditMessageCaption

Edits the message content caption. Returns the edited message after the edit is completed on the server side.

EditMessageCaptionBuilder
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.

EditMessageLiveLocationBuilder
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.

EditMessageMediaBuilder
EditMessageReplyMarkup

Edits the message reply markup; for bots only. Returns the edited message after the edit is completed on the server side.

EditMessageReplyMarkupBuilder
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.

EditMessageTextBuilder
EditProxy

Edits an existing proxy server for network requests. Can be called before authorization.

EditProxyBuilder
EmailAddressAuthenticationCodeInfo

Information about the email address authentication code that was sent.

EmailAddressAuthenticationCodeInfoBuilder
EnableProxy

Enables a proxy. Only one proxy can be enabled at a time. Can be called before authorization.

EnableProxyBuilder
EncryptedCredentials

Contains encrypted Telegram Passport data credentials.

EncryptedCredentialsBuilder
EncryptedPassportElement

Contains information about an encrypted Telegram Passport element; for bots only.

EncryptedPassportElementBuilder
Error

An object of this type can be returned on every function call, in case of an error.

ErrorBuilder
File

Represents a file.

FileBuilder
FilePart

Contains a part of a file.

FilePartBuilder
FileTypeAnimation

The file is an animation.

FileTypeAnimationBuilder
FileTypeAudio

The file is an audio file.

FileTypeAudioBuilder
FileTypeDocument

The file is a document.

FileTypeDocumentBuilder
FileTypeNone

The data is not a file.

FileTypeNoneBuilder
FileTypePhoto

The file is a photo.

FileTypePhotoBuilder
FileTypeProfilePhoto

The file is a profile photo.

FileTypeProfilePhotoBuilder
FileTypeSecret

The file was sent to a secret chat (the file type is not known to the server).

FileTypeSecretBuilder
FileTypeSecretThumbnail

The file is a thumbnail of a file from a secret chat.

FileTypeSecretThumbnailBuilder
FileTypeSecure

The file is a file from Secure storage used for storing Telegram Passport files.

FileTypeSecureBuilder
FileTypeSticker

The file is a sticker.

FileTypeStickerBuilder
FileTypeThumbnail

The file is a thumbnail of another file.

FileTypeThumbnailBuilder
FileTypeUnknown

The file type is not yet known.

FileTypeUnknownBuilder
FileTypeVideo

The file is a video.

FileTypeVideoBuilder
FileTypeVideoNote

The file is a video note.

FileTypeVideoNoteBuilder
FileTypeVoiceNote

The file is a voice note.

FileTypeVoiceNoteBuilder
FileTypeWallpaper

The file is a wallpaper.

FileTypeWallpaperBuilder
FinishFileGeneration

Finishes the file generation.

FinishFileGenerationBuilder
FormattedText

A text with some entities.

FormattedTextBuilder
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.

ForwardMessagesBuilder
FoundMessages

Contains a list of messages found by a search.

FoundMessagesBuilder
Game

Describes a game.

GameBuilder
GameHighScore

Contains one row of the game high score table.

GameHighScoreBuilder
GameHighScores

Contains a list of game high scores.

GameHighScoresBuilder
GenerateChatInviteLink

Generates a new invite link for a chat; the previously generated link is revoked. Available for basic groups, supergroups, and channels. In basic groups this can be called only by the group's creator; in supergroups and channels this requires appropriate administrator rights.

GenerateChatInviteLinkBuilder
GetAccountTtl

Returns the period of inactivity after which the account of the current user will automatically be deleted.

GetAccountTtlBuilder
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.

GetActiveLiveLocationMessagesBuilder
GetActiveSessions

Returns all active sessions of the current user.

GetActiveSessionsBuilder
GetAllPassportElements

Returns all available Telegram Passport elements.

GetAllPassportElementsBuilder
GetApplicationConfig

Returns application config, provided by the server. Can be called before authorization.

GetApplicationConfigBuilder
GetArchivedStickerSets

Returns a list of archived sticker sets.

GetArchivedStickerSetsBuilder
GetAttachedStickerSets

Returns a list of sticker sets attached to a file. Currently only photos and videos can have attached sticker sets.

GetAttachedStickerSetsBuilder
GetAuthorizationState

Returns the current authorization state; this is an offline request. For informational purposes only. Use

GetAuthorizationStateBuilder
GetBasicGroup

Returns information about a basic group by its identifier. This is an offline request if the current user is not a bot.

GetBasicGroupBuilder
GetBasicGroupFullInfo

Returns full information about a basic group by its identifier.

GetBasicGroupFullInfoBuilder
GetBlockedUsers

Returns users that were blocked by the current user.

GetBlockedUsersBuilder
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.

GetCallbackQueryAnswerBuilder
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 users who are administrators of the chat.

GetChatAdministratorsBuilder
GetChatBuilder
GetChatEventLog

Returns a list of service actions taken by chat members and administrators in the last 48 hours. Available only in supergroups and channels. Requires administrator rights. Returns results in reverse chronological order (i. e., in order of decreasing event_id).

GetChatEventLogBuilder
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.

GetChatHistoryBuilder
GetChatMember

Returns information about a single member of a chat.

GetChatMemberBuilder
GetChatMessageByDate

Returns the last message sent in a chat no later than the specified date.

GetChatMessageByDateBuilder
GetChatMessageCount

Returns approximate number of messages of the specified type in the chat.

GetChatMessageCountBuilder
GetChatNotificationSettingsExceptions

Returns list of chats with non-default notification settings.

GetChatNotificationSettingsExceptionsBuilder
GetChatPinnedMessage

Returns information about a pinned chat message.

GetChatPinnedMessageBuilder
GetChatReportSpamState

Returns information on whether the current chat can be reported as spam.

GetChatReportSpamStateBuilder
GetChatStatisticsUrl

Returns URL with the chat statistics. Currently this method can be used only for channels.

GetChatStatisticsUrlBuilder
GetChats

Returns an ordered list of chats. 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.

GetChatsBuilder
GetConnectedWebsites

Returns all website where the current user used Telegram to log in.

GetConnectedWebsitesBuilder
GetContacts

Returns all user contacts.

GetContactsBuilder
GetCountryCode

Uses current user IP to found his country. Returns two-letter ISO 3166-1 alpha-2 country code. Can be called before authorization.

GetCountryCodeBuilder
GetCreatedPublicChats

Returns a list of public chats created by the user.

GetCreatedPublicChatsBuilder
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.

GetCurrentStateBuilder
GetDatabaseStatistics

Returns database statistics.

GetDatabaseStatisticsBuilder
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.

GetDeepLinkInfoBuilder
GetFavoriteStickers

Returns favorite stickers.

GetFavoriteStickersBuilder
GetFile

Returns information about a file; this is an offline request.

GetFileBuilder
GetFileDownloadedPrefixSize

Returns file downloaded prefix size from a given offset.

GetFileDownloadedPrefixSizeBuilder
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.

GetFileExtensionBuilder
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.

GetFileMimeTypeBuilder
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.

GetGameHighScoresBuilder
GetGroupsInCommon

Returns a list of common group chats with a given user. Chats are sorted by their type and creation date.

GetGroupsInCommonBuilder
GetImportedContactCount

Returns the total number of imported contacts.

GetImportedContactCountBuilder
GetInlineGameHighScores

Returns game high scores and some part of the high score table in the range of the specified user; for bots only.

GetInlineGameHighScoresBuilder
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.

GetInlineQueryResultsBuilder
GetInstalledStickerSets

Returns a list of installed sticker sets.

GetInstalledStickerSetsBuilder
GetInviteText

Returns the default text for invitation messages to be used as a placeholder when the current user invites friends to Telegram.

GetInviteTextBuilder
GetLanguagePackInfo

Returns information about a language pack. Returned language pack identifier may be different from a provided one. Can be called before authorization.

GetLanguagePackInfoBuilder
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.

GetLanguagePackStringBuilder
GetLanguagePackStrings

Returns strings from a language pack in the current localization target by their keys. Can be called before authorization.

GetLanguagePackStringsBuilder
GetLocalizationTargetInfo

Returns information about the current localization target. This is an offline request if only_local is true. Can be called before authorization.

GetLocalizationTargetInfoBuilder
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.

GetLogStreamBuilder
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.

GetLogTagVerbosityLevelBuilder
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.

GetLogTagsBuilder
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.

GetLogVerbosityLevelBuilder
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.

GetMapThumbnailFileBuilder
GetMe

Returns the current user.

GetMeBuilder
GetMessage

Returns information about a message.

GetMessageBuilder
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.

GetMessageLinkBuilder
GetMessageLocally

Returns information about a message, if it is available locally without sending network request. This is an offline request.

GetMessageLocallyBuilder
GetMessages

Returns information about messages. If a message is not found, returns null on the corresponding position of the result.

GetMessagesBuilder
GetNetworkStatistics

Returns network data usage statistics. Can be called before authorization.

GetNetworkStatisticsBuilder
GetOption

Returns the value of an option by its name. (Check the list of available options on

GetOptionBuilder
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.

GetPassportAuthorizationFormAvailableElementsBuilder
GetPassportAuthorizationFormBuilder
GetPassportElement

Returns one of the available Telegram Passport elements.

GetPassportElementBuilder
GetPasswordState

Returns the current state of 2-step verification.

GetPasswordStateBuilder
GetPaymentForm

Returns an invoice payment form. This method should be called when the user presses inlineKeyboardButtonBuy.

GetPaymentFormBuilder
GetPaymentReceipt

Returns information about a successful payment.

GetPaymentReceiptBuilder
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.

GetPreferredCountryLanguageBuilder
GetProxies

Returns list of proxies that are currently set up. Can be called before authorization.

GetProxiesBuilder
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.

GetProxyLinkBuilder
GetPublicMessageLink

Returns a public HTTPS link to a message. Available only for messages in public supergroups and channels.

GetPublicMessageLinkBuilder
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.

GetPushReceiverIdBuilder
GetRecentInlineBots

Returns up to 20 recently used inline bots in the order of their last usage.

GetRecentInlineBotsBuilder
GetRecentStickers

Returns a list of recently used stickers.

GetRecentStickersBuilder
GetRecentlyVisitedTMeUrls

Returns t.me URLs recently visited by a newly registered user.

GetRecentlyVisitedTMeUrlsBuilder
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.

GetRecoveryEmailAddressBuilder
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.

GetRemoteFileBuilder
GetRepliedMessage

Returns information about a message that is replied by given message.

GetRepliedMessageBuilder
GetSavedAnimations

Returns saved animations.

GetSavedAnimationsBuilder
GetSavedOrderInfo

Returns saved order info, if any.

GetSavedOrderInfoBuilder
GetScopeNotificationSettings

Returns the notification settings for chats of a given type.

GetScopeNotificationSettingsBuilder
GetSecretChat

Returns information about a secret chat by its identifier. This is an offline request.

GetSecretChatBuilder
GetStickerEmojis

Returns emoji corresponding to a sticker.

GetStickerEmojisBuilder
GetStickerSet

Returns information about a sticker set by its identifier.

GetStickerSetBuilder
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.

GetStickersBuilder
GetStorageStatistics

Returns storage usage statistics. Can be called before authorization.

GetStorageStatisticsBuilder
GetStorageStatisticsFast

Quickly returns approximate storage usage statistics. Can be called before authorization.

GetStorageStatisticsFastBuilder
GetSupergroup

Returns information about a supergroup or channel by its identifier. This is an offline request if the current user is not a bot.

GetSupergroupBuilder
GetSupergroupFullInfo

Returns full information about a supergroup or channel by its identifier, cached for up to 1 minute.

GetSupergroupFullInfoBuilder
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.

GetSupergroupMembersBuilder
GetSupportUser

Returns a user that can be contacted to get support.

GetSupportUserBuilder
GetTemporaryPasswordState

Returns information about the current temporary password.

GetTemporaryPasswordStateBuilder
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.

GetTextEntitiesBuilder
GetTopChats

Returns a list of frequently used chats. Supported only if the chat info database is enabled.

GetTopChatsBuilder
GetTrendingStickerSets

Returns a list of trending sticker sets.

GetTrendingStickerSetsBuilder
GetUser

Returns information about a user by their identifier. This is an offline request if the current user is not a bot.

GetUserBuilder
GetUserFullInfo

Returns full information about a user by their identifier.

GetUserFullInfoBuilder
GetUserPrivacySettingRules

Returns the current privacy settings.

GetUserPrivacySettingRulesBuilder
GetUserProfilePhotos

Returns the profile photos of a user. The result of this query may be outdated: some photos might have been deleted already.

GetUserProfilePhotosBuilder
GetWallpapers

Returns background wallpapers.

GetWallpapersBuilder
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.

GetWebPageInstantViewBuilder
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.

GetWebPagePreviewBuilder
Hashtags

Contains a list of hashtags.

HashtagsBuilder
HttpUrl

Contains an HTTP URL.

HttpUrlBuilder
IdentityDocument

An identity document.

IdentityDocumentBuilder
ImportContacts

Adds new contacts or edits existing contacts; contacts' user identifiers are ignored.

ImportContactsBuilder
ImportedContacts

Represents the result of an ImportContacts request.

ImportedContactsBuilder
InlineKeyboardButton

Represents a single button in an inline keyboard.

InlineKeyboardButtonBuilder
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

InlineKeyboardButtonTypeBuyBuilder
InlineKeyboardButtonTypeCallback

A button that sends a special callback query to a bot.

InlineKeyboardButtonTypeCallbackBuilder
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

InlineKeyboardButtonTypeCallbackGameBuilder
InlineKeyboardButtonTypeSwitchInline

A button that forces an inline query to the bot to be inserted in the input field.

InlineKeyboardButtonTypeSwitchInlineBuilder
InlineKeyboardButtonTypeUrl

A button that opens a specified URL.

InlineKeyboardButtonTypeUrlBuilder
InlineQueryResultAnimation

Represents an animation file.

InlineQueryResultAnimationBuilder
InlineQueryResultArticle

Represents a link to an article or web page.

InlineQueryResultArticleBuilder
InlineQueryResultAudio

Represents an audio file.

InlineQueryResultAudioBuilder
InlineQueryResultContact

Represents a user contact.

InlineQueryResultContactBuilder
InlineQueryResultDocument

Represents a document.

InlineQueryResultDocumentBuilder
InlineQueryResultGame

Represents information about a game.

InlineQueryResultGameBuilder
InlineQueryResultLocation

Represents a point on the map.

InlineQueryResultLocationBuilder
InlineQueryResultPhoto

Represents a photo.

InlineQueryResultPhotoBuilder
InlineQueryResultSticker

Represents a sticker.

InlineQueryResultStickerBuilder
InlineQueryResultVenue

Represents information about a venue.

InlineQueryResultVenueBuilder
InlineQueryResultVideo

Represents a video.

InlineQueryResultVideoBuilder
InlineQueryResultVoiceNote

Represents a voice note.

InlineQueryResultVoiceNoteBuilder
InlineQueryResults

Represents the results of the inline query. Use

InlineQueryResultsBuilder
InputCredentialsAndroidPay

Applies if a user enters new credentials using Android Pay.

InputCredentialsAndroidPayBuilder
InputCredentialsApplePay

Applies if a user enters new credentials using Apple Pay.

InputCredentialsApplePayBuilder
InputCredentialsNew

Applies if a user enters new credentials on a payment provider website.

InputCredentialsNewBuilder
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.

InputCredentialsSavedBuilder
InputFileGenerated

A file generated by the client.

InputFileGeneratedBuilder
InputFileId

A file defined by its unique ID.

InputFileIdBuilder
InputFileLocal

A file defined by a local path.

InputFileLocalBuilder
InputFileRemote

A file defined by its remote ID.

InputFileRemoteBuilder
InputIdentityDocument

An identity document to be saved to Telegram Passport.

InputIdentityDocumentBuilder
InputInlineQueryResultAnimatedGif

Represents a link to an animated GIF.

InputInlineQueryResultAnimatedGifBuilder
InputInlineQueryResultAnimatedMpeg4

Represents a link to an animated (i.e. without sound) H.264/MPEG-4 AVC video.

InputInlineQueryResultAnimatedMpeg4Builder
InputInlineQueryResultArticle

Represents a link to an article or web page.

InputInlineQueryResultArticleBuilder
InputInlineQueryResultAudio

Represents a link to an MP3 audio file.

InputInlineQueryResultAudioBuilder
InputInlineQueryResultContact

Represents a user contact.

InputInlineQueryResultContactBuilder
InputInlineQueryResultDocument

Represents a link to a file.

InputInlineQueryResultDocumentBuilder
InputInlineQueryResultGame

Represents a game.

InputInlineQueryResultGameBuilder
InputInlineQueryResultLocation

Represents a point on the map.

InputInlineQueryResultLocationBuilder
InputInlineQueryResultPhoto

Represents link to a JPEG image.

InputInlineQueryResultPhotoBuilder
InputInlineQueryResultSticker

Represents a link to a WEBP sticker.

InputInlineQueryResultStickerBuilder
InputInlineQueryResultVenue

Represents information about a venue.

InputInlineQueryResultVenueBuilder
InputInlineQueryResultVideo

Represents a link to a page containing an embedded video player or a video file.

InputInlineQueryResultVideoBuilder
InputInlineQueryResultVoiceNote

Represents a link to an opus-encoded audio file within an OGG container, single channel audio.

InputInlineQueryResultVoiceNoteBuilder
InputMessageAnimation

An animation message (GIF-style).

InputMessageAnimationBuilder
InputMessageAudio

An audio message.

InputMessageAudioBuilder
InputMessageContact

A message containing a user contact.

InputMessageContactBuilder
InputMessageDocument

A document message (general file).

InputMessageDocumentBuilder
InputMessageForwarded

A forwarded message.

InputMessageForwardedBuilder
InputMessageGame

A message with a game; not supported for channels or secret chats.

InputMessageGameBuilder
InputMessageInvoice

A message with an invoice; can be used only by bots and only in private chats.

InputMessageInvoiceBuilder
InputMessageLocation

A message with a location.

InputMessageLocationBuilder
InputMessagePhoto

A photo message.

InputMessagePhotoBuilder
InputMessagePoll

A message with a poll. Polls can't be sent to private or secret chats.

InputMessagePollBuilder
InputMessageSticker

A sticker message.

InputMessageStickerBuilder
InputMessageText

A text message.

InputMessageTextBuilder
InputMessageVenue

A message with information about a venue.

InputMessageVenueBuilder
InputMessageVideo

A video message.

InputMessageVideoBuilder
InputMessageVideoNote

A video note message.

InputMessageVideoNoteBuilder
InputMessageVoiceNote

A voice note message.

InputMessageVoiceNoteBuilder
InputPassportElementAddress

A Telegram Passport element to be saved containing the user's address.

InputPassportElementAddressBuilder
InputPassportElementBankStatement

A Telegram Passport element to be saved containing the user's bank statement.

InputPassportElementBankStatementBuilder
InputPassportElementDriverLicense

A Telegram Passport element to be saved containing the user's driver license.

InputPassportElementDriverLicenseBuilder
InputPassportElementEmailAddress

A Telegram Passport element to be saved containing the user's email address.

InputPassportElementEmailAddressBuilder
InputPassportElementError

Contains the description of an error in a Telegram Passport element; for bots only.

InputPassportElementErrorBuilder
InputPassportElementErrorSourceDataField

A data field contains an error. The error is considered resolved when the field's value changes.

InputPassportElementErrorSourceDataFieldBuilder
InputPassportElementErrorSourceFile

The file contains an error. The error is considered resolved when the file changes.

InputPassportElementErrorSourceFileBuilder
InputPassportElementErrorSourceFiles

The list of attached files contains an error. The error is considered resolved when the file list changes.

InputPassportElementErrorSourceFilesBuilder
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.

InputPassportElementErrorSourceFrontSideBuilder
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.

InputPassportElementErrorSourceReverseSideBuilder
InputPassportElementErrorSourceSelfie

The selfie contains an error. The error is considered resolved when the file with the selfie changes.

InputPassportElementErrorSourceSelfieBuilder
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.

InputPassportElementErrorSourceTranslationFileBuilder
InputPassportElementErrorSourceTranslationFiles

The translation of the document contains an error. The error is considered resolved when the list of files changes.

InputPassportElementErrorSourceTranslationFilesBuilder
InputPassportElementErrorSourceUnspecified

The element contains an error in an unspecified place. The error will be considered resolved when new data is added.

InputPassportElementErrorSourceUnspecifiedBuilder
InputPassportElementIdentityCard

A Telegram Passport element to be saved containing the user's identity card.

InputPassportElementIdentityCardBuilder
InputPassportElementInternalPassport

A Telegram Passport element to be saved containing the user's internal passport.

InputPassportElementInternalPassportBuilder
InputPassportElementPassport

A Telegram Passport element to be saved containing the user's passport.

InputPassportElementPassportBuilder
InputPassportElementPassportRegistration

A Telegram Passport element to be saved containing the user's passport registration.

InputPassportElementPassportRegistrationBuilder
InputPassportElementPersonalDetails

A Telegram Passport element to be saved containing the user's personal details.

InputPassportElementPersonalDetailsBuilder
InputPassportElementPhoneNumber

A Telegram Passport element to be saved containing the user's phone number.

InputPassportElementPhoneNumberBuilder
InputPassportElementRentalAgreement

A Telegram Passport element to be saved containing the user's rental agreement.

InputPassportElementRentalAgreementBuilder
InputPassportElementTemporaryRegistration

A Telegram Passport element to be saved containing the user's temporary registration.

InputPassportElementTemporaryRegistrationBuilder
InputPassportElementUtilityBill

A Telegram Passport element to be saved containing the user's utility bill.

InputPassportElementUtilityBillBuilder
InputPersonalDocument

A personal document to be saved to Telegram Passport.

InputPersonalDocumentBuilder
InputSticker

Describes a sticker that should be added to a sticker set.

InputStickerBuilder
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.

InputThumbnailBuilder
Invoice

Product invoice.

InvoiceBuilder
JoinChat

Adds current user as a new member to a chat. Private and secret chats can't be joined using this method.

JoinChatBuilder
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.

JoinChatByInviteLinkBuilder
KeyboardButton

Represents a single button in a bot keyboard.

KeyboardButtonBuilder
KeyboardButtonTypeRequestLocation

A button that sends the user's location when pressed; available only in private chats.

KeyboardButtonTypeRequestLocationBuilder
KeyboardButtonTypeRequestPhoneNumber

A button that sends the user's phone number when pressed; available only in private chats.

KeyboardButtonTypeRequestPhoneNumberBuilder
KeyboardButtonTypeText

A simple button, with text that should be sent when the button is pressed.

KeyboardButtonTypeTextBuilder
LabeledPricePart

Portion of the price of a product (e.g., "delivery cost", "tax amount").

LabeledPricePartBuilder
LanguagePackInfo

Contains information about a language pack.

LanguagePackInfoBuilder
LanguagePackString

Represents one language pack string.

LanguagePackStringBuilder
LanguagePackStringValueDeleted

A deleted language pack string, the value should be taken from the built-in english language pack.

LanguagePackStringValueDeletedBuilder
LanguagePackStringValueOrdinary

An ordinary language pack string.

LanguagePackStringValueOrdinaryBuilder
LanguagePackStringValuePluralized

A language pack string which has different forms based on the number of some object it mentions. See

LanguagePackStringValuePluralizedBuilder
LanguagePackStrings

Contains a list of language pack strings.

LanguagePackStringsBuilder
LeaveChat

Removes current user from chat members. Private and secret chats can't be left using this method.

LeaveChatBuilder
LinkStateIsContact

The phone number of user A has been saved to the contact list of user B.

LinkStateIsContactBuilder
LinkStateKnowsPhoneNumber

The phone number of user A is known but that number has not been saved to the contact list of user B.

LinkStateKnowsPhoneNumberBuilder
LinkStateNone

The phone number of user A is not known to user B.

LinkStateNoneBuilder
LocalFile

Represents a local file.

LocalFileBuilder
LocalizationTargetInfo

Contains information about the current localization target.

LocalizationTargetInfoBuilder
Location

Describes a location on planet Earth.

LocationBuilder
LogOut

Closes the TDLib instance after a proper logout. Requires an available network connection. All local data will be destroyed. After the logout completes,

LogOutBuilder
LogStreamDefault

The log is written to stderr or an OS specific log.

LogStreamDefaultBuilder
LogStreamEmpty

The log is written nowhere.

LogStreamEmptyBuilder
LogStreamFile

The log is written to a file.

LogStreamFileBuilder
LogTags

Contains a list of available TDLib internal log tags.

LogTagsBuilder
LogVerbosityLevel

Contains a TDLib internal log verbosity level.

LogVerbosityLevelBuilder
MaskPointChin

A mask should be placed relatively to the chin.

MaskPointChinBuilder
MaskPointEyes

A mask should be placed relatively to the eyes.

MaskPointEyesBuilder
MaskPointForehead

A mask should be placed relatively to the forehead.

MaskPointForeheadBuilder
MaskPointMouth

A mask should be placed relatively to the mouth.

MaskPointMouthBuilder
MaskPosition

Position on a photo where a mask should be placed.

MaskPositionBuilder
Message

Describes a message.

MessageAnimation

An animation message (GIF-style).

MessageAnimationBuilder
MessageAudio

An audio message.

MessageAudioBuilder
MessageBasicGroupChatCreate

A newly created basic group.

MessageBasicGroupChatCreateBuilder
MessageBuilder
MessageCall

A message with information about an ended call.

MessageCallBuilder
MessageChatAddMembers

New chat members were added.

MessageChatAddMembersBuilder
MessageChatChangePhoto

An updated chat photo.

MessageChatChangePhotoBuilder
MessageChatChangeTitle

An updated chat title.

MessageChatChangeTitleBuilder
MessageChatDeleteMember

A chat member was deleted.

MessageChatDeleteMemberBuilder
MessageChatDeletePhoto

A deleted chat photo.

MessageChatDeletePhotoBuilder
MessageChatJoinByLink

A new member joined the chat by invite link.

MessageChatJoinByLinkBuilder
MessageChatSetTtl

The TTL (Time To Live) setting messages in a secret chat has been changed.

MessageChatSetTtlBuilder
MessageChatUpgradeFrom

A supergroup has been created from a basic group.

MessageChatUpgradeFromBuilder
MessageChatUpgradeTo

A basic group was upgraded to a supergroup and was deactivated as the result.

MessageChatUpgradeToBuilder
MessageContact

A message with a user contact.

MessageContactBuilder
MessageContactRegistered

A contact has registered with Telegram.

MessageContactRegisteredBuilder
MessageCustomServiceAction

A non-standard action has happened in the chat.

MessageCustomServiceActionBuilder
MessageDocument

A document message (general file).

MessageDocumentBuilder
MessageExpiredPhoto

An expired photo message (self-destructed after TTL has elapsed).

MessageExpiredPhotoBuilder
MessageExpiredVideo

An expired video message (self-destructed after TTL has elapsed).

MessageExpiredVideoBuilder
MessageForwardInfo

Contains information about a forwarded message.

MessageForwardInfoBuilder
MessageForwardOriginChannel

The message was originally a post in a channel.

MessageForwardOriginChannelBuilder
MessageForwardOriginHiddenUser

The message was originally written by a user, which is hidden by his privacy settings.

MessageForwardOriginHiddenUserBuilder
MessageForwardOriginUser

The message was originally written by a known user.

MessageForwardOriginUserBuilder
MessageGame

A message with a game.

MessageGameBuilder
MessageGameScore

A new high score was achieved in a game.

MessageGameScoreBuilder
MessageInvoice

A message with an invoice from a bot.

MessageInvoiceBuilder
MessageLocation

A message with a location.

MessageLocationBuilder
MessagePassportDataReceived

Telegram Passport data has been received; for bots only.

MessagePassportDataReceivedBuilder
MessagePassportDataSent

Telegram Passport data has been sent.

MessagePassportDataSentBuilder
MessagePaymentSuccessful

A payment has been completed.

MessagePaymentSuccessfulBot

A payment has been completed; for bots only.

MessagePaymentSuccessfulBotBuilder
MessagePaymentSuccessfulBuilder
MessagePhoto

A photo message.

MessagePhotoBuilder
MessagePinMessage

A message has been pinned.

MessagePinMessageBuilder
MessagePoll

A message with a poll.

MessagePollBuilder
MessageScreenshotTaken

A screenshot of a message in the chat has been taken.

MessageScreenshotTakenBuilder
MessageSendingStateFailed

The message failed to be sent.

MessageSendingStateFailedBuilder
MessageSendingStatePending

The message is being sent now, but has not yet been delivered to the server.

MessageSendingStatePendingBuilder
MessageSticker

A sticker message.

MessageStickerBuilder
MessageSupergroupChatCreate

A newly created supergroup or channel.

MessageSupergroupChatCreateBuilder
MessageText

A text message.

MessageTextBuilder
MessageUnsupported

Message content that is not supported by the client.

MessageUnsupportedBuilder
MessageVenue

A message with information about a venue.

MessageVenueBuilder
MessageVideo

A video message.

MessageVideoBuilder
MessageVideoNote

A video note message.

MessageVideoNoteBuilder
MessageVoiceNote

A voice note message.

MessageVoiceNoteBuilder
MessageWebsiteConnected

The current user has connected a website by logging in using Telegram Login Widget on it.

MessageWebsiteConnectedBuilder
Messages

Contains a list of messages.

MessagesBuilder
NetworkStatistics

A full list of available network statistic entries.

NetworkStatisticsBuilder
NetworkStatisticsEntryCall

Contains information about the total amount of data that was used for calls.

NetworkStatisticsEntryCallBuilder
NetworkStatisticsEntryFile

Contains information about the total amount of data that was used to send and receive files.

NetworkStatisticsEntryFileBuilder
NetworkTypeMobile

A mobile network.

NetworkTypeMobileBuilder
NetworkTypeMobileRoaming

A mobile roaming network.

NetworkTypeMobileRoamingBuilder
NetworkTypeNone

The network is not available.

NetworkTypeNoneBuilder
NetworkTypeOther

A different network type (e.g., Ethernet network).

NetworkTypeOtherBuilder
NetworkTypeWiFi

A Wi-Fi network.

NetworkTypeWiFiBuilder
Notification

Contains information about a notification.

NotificationBuilder
NotificationGroup

Describes a group of notifications.

NotificationGroupBuilder
NotificationGroupTypeCalls

A group containing notifications of type

NotificationGroupTypeCallsBuilder
NotificationGroupTypeMentions

A group containing notifications of type

NotificationGroupTypeMentionsBuilder
NotificationGroupTypeMessages

A group containing notifications of type

NotificationGroupTypeMessagesBuilder
NotificationGroupTypeSecretChat

A group containing a notification of type

NotificationGroupTypeSecretChatBuilder
NotificationSettingsScopeChannelChats

Notification settings applied to all channels when the corresponding chat setting has a default value.

NotificationSettingsScopeChannelChatsBuilder
NotificationSettingsScopeGroupChats

Notification settings applied to all basic groups and supergroups when the corresponding chat setting has a default value.

NotificationSettingsScopeGroupChatsBuilder
NotificationSettingsScopePrivateChats

Notification settings applied to all private and secret chats when the corresponding chat setting has a default value.

NotificationSettingsScopePrivateChatsBuilder
NotificationTypeNewCall

New call was received.

NotificationTypeNewCallBuilder
NotificationTypeNewMessage

New message was received.

NotificationTypeNewMessageBuilder
NotificationTypeNewPushMessage

New message was received through a push notification.

NotificationTypeNewPushMessageBuilder
NotificationTypeNewSecretChat

New secret chat was created.

NotificationTypeNewSecretChatBuilder
Ok

An object of this type is returned on a successful function call for certain functions.

OkBuilder
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).

OpenChatBuilder
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

OpenMessageContentBuilder
OptimizeStorage

Optimizes storage usage, i.e. deletes some files and returns new storage usage statistics. Secret thumbnails can't be deleted.

OptimizeStorageBuilder
OptionValueBoolean

Represents a boolean option.

OptionValueBooleanBuilder
OptionValueEmpty

Represents an unknown option or an option which has a default value.

OptionValueEmptyBuilder
OptionValueInteger

Represents an integer option.

OptionValueIntegerBuilder
OptionValueString

Represents a string option.

OptionValueStringBuilder
OrderInfo

Order information.

OrderInfoBuilder
PageBlockAnchor

An invisible anchor on a page, which can be used in a URL to open the page from the specified anchor.

PageBlockAnchorBuilder
PageBlockAnimation

An animation.

PageBlockAnimationBuilder
PageBlockAudio

An audio file.

PageBlockAudioBuilder
PageBlockAuthorDate

The author and publishing date of a page.

PageBlockAuthorDateBuilder
PageBlockBlockQuote

A block quote.

PageBlockBlockQuoteBuilder
PageBlockCaption

Contains a caption of an instant view web page block, consisting of a text and a trailing credit.

PageBlockCaptionBuilder
PageBlockChatLink

A link to a chat.

PageBlockChatLinkBuilder
PageBlockCollage

A collage.

PageBlockCollageBuilder
PageBlockCover

A page cover.

PageBlockCoverBuilder
PageBlockDetails

A collapsible block.

PageBlockDetailsBuilder
PageBlockDivider

An empty block separating a page.

PageBlockDividerBuilder
PageBlockEmbedded

An embedded web page.

PageBlockEmbeddedBuilder
PageBlockEmbeddedPost

An embedded post.

PageBlockEmbeddedPostBuilder
PageBlockFooter

The footer of a page.

PageBlockFooterBuilder
PageBlockHeader

A header.

PageBlockHeaderBuilder
PageBlockHorizontalAlignmentCenter

The content should be center-aligned.

PageBlockHorizontalAlignmentCenterBuilder
PageBlockHorizontalAlignmentLeft

The content should be left-aligned.

PageBlockHorizontalAlignmentLeftBuilder
PageBlockHorizontalAlignmentRight

The content should be right-aligned.

PageBlockHorizontalAlignmentRightBuilder
PageBlockKicker

A kicker.

PageBlockKickerBuilder
PageBlockList

A list of data blocks.

PageBlockListBuilder
PageBlockListItem

Describes an item of a list page block.

PageBlockListItemBuilder
PageBlockMap

A map.

PageBlockMapBuilder
PageBlockParagraph

A text paragraph.

PageBlockParagraphBuilder
PageBlockPhoto

A photo.

PageBlockPhotoBuilder
PageBlockPreformatted

A preformatted text paragraph.

PageBlockPreformattedBuilder
PageBlockPullQuote

A pull quote.

PageBlockPullQuoteBuilder
PageBlockRelatedArticle

Contains information about a related article.

PageBlockRelatedArticleBuilder
PageBlockRelatedArticles

Related articles.

PageBlockRelatedArticlesBuilder
PageBlockSlideshow

A slideshow.

PageBlockSlideshowBuilder
PageBlockSubheader

A subheader.

PageBlockSubheaderBuilder
PageBlockSubtitle

The subtitle of a page.

PageBlockSubtitleBuilder
PageBlockTable

A table.

PageBlockTableBuilder
PageBlockTableCell

Represents a cell of a table.

PageBlockTableCellBuilder
PageBlockTitle

The title of a page.

PageBlockTitleBuilder
PageBlockVerticalAlignmentBottom

The content should be bottom-aligned.

PageBlockVerticalAlignmentBottomBuilder
PageBlockVerticalAlignmentMiddle

The content should be middle-aligned.

PageBlockVerticalAlignmentMiddleBuilder
PageBlockVerticalAlignmentTop

The content should be top-aligned.

PageBlockVerticalAlignmentTopBuilder
PageBlockVideo

A video.

PageBlockVideoBuilder
ParseTextEntities

Parses Bold, Italic, Code, Pre, PreCode and TextUrl entities contained in the text. This is an offline method. Can be called before authorization. Can be called synchronously.

ParseTextEntitiesBuilder
PassportAuthorizationForm

Contains information about a Telegram Passport authorization form that was requested.

PassportAuthorizationFormBuilder
PassportElementAddress

A Telegram Passport element containing the user's address.

PassportElementAddressBuilder
PassportElementBankStatement

A Telegram Passport element containing the user's bank statement.

PassportElementBankStatementBuilder
PassportElementDriverLicense

A Telegram Passport element containing the user's driver license.

PassportElementDriverLicenseBuilder
PassportElementEmailAddress

A Telegram Passport element containing the user's email address.

PassportElementEmailAddressBuilder
PassportElementError

Contains the description of an error in a Telegram Passport element.

PassportElementErrorBuilder
PassportElementErrorSourceDataField

One of the data fields contains an error. The error will be considered resolved when the value of the field changes.

PassportElementErrorSourceDataFieldBuilder
PassportElementErrorSourceFile

The file contains an error. The error will be considered resolved when the file changes.

PassportElementErrorSourceFileBuilder
PassportElementErrorSourceFiles

The list of attached files contains an error. The error will be considered resolved when the list of files changes.

PassportElementErrorSourceFilesBuilder
PassportElementErrorSourceFrontSide

The front side of the document contains an error. The error will be considered resolved when the file with the front side changes.

PassportElementErrorSourceFrontSideBuilder
PassportElementErrorSourceReverseSide

The reverse side of the document contains an error. The error will be considered resolved when the file with the reverse side changes.

PassportElementErrorSourceReverseSideBuilder
PassportElementErrorSourceSelfie

The selfie with the document contains an error. The error will be considered resolved when the file with the selfie changes.

PassportElementErrorSourceSelfieBuilder
PassportElementErrorSourceTranslationFile

One of files with the translation of the document contains an error. The error will be considered resolved when the file changes.

PassportElementErrorSourceTranslationFileBuilder
PassportElementErrorSourceTranslationFiles

The translation of the document contains an error. The error will be considered resolved when the list of translation files changes.

PassportElementErrorSourceTranslationFilesBuilder
PassportElementErrorSourceUnspecified

The element contains an error in an unspecified place. The error will be considered resolved when new data is added.

PassportElementErrorSourceUnspecifiedBuilder
PassportElementIdentityCard

A Telegram Passport element containing the user's identity card.

PassportElementIdentityCardBuilder
PassportElementInternalPassport

A Telegram Passport element containing the user's internal passport.

PassportElementInternalPassportBuilder
PassportElementPassport

A Telegram Passport element containing the user's passport.

PassportElementPassportBuilder
PassportElementPassportRegistration

A Telegram Passport element containing the user's passport registration pages.

PassportElementPassportRegistrationBuilder
PassportElementPersonalDetails

A Telegram Passport element containing the user's personal details.

PassportElementPersonalDetailsBuilder
PassportElementPhoneNumber

A Telegram Passport element containing the user's phone number.

PassportElementPhoneNumberBuilder
PassportElementRentalAgreement

A Telegram Passport element containing the user's rental agreement.

PassportElementRentalAgreementBuilder
PassportElementTemporaryRegistration

A Telegram Passport element containing the user's temporary registration.

PassportElementTemporaryRegistrationBuilder
PassportElementTypeAddress

A Telegram Passport element containing the user's address.

PassportElementTypeAddressBuilder
PassportElementTypeBankStatement

A Telegram Passport element containing the user's bank statement.

PassportElementTypeBankStatementBuilder
PassportElementTypeDriverLicense

A Telegram Passport element containing the user's driver license.

PassportElementTypeDriverLicenseBuilder
PassportElementTypeEmailAddress

A Telegram Passport element containing the user's email address.

PassportElementTypeEmailAddressBuilder
PassportElementTypeIdentityCard

A Telegram Passport element containing the user's identity card.

PassportElementTypeIdentityCardBuilder
PassportElementTypeInternalPassport

A Telegram Passport element containing the user's internal passport.

PassportElementTypeInternalPassportBuilder
PassportElementTypePassport

A Telegram Passport element containing the user's passport.

PassportElementTypePassportBuilder
PassportElementTypePassportRegistration

A Telegram Passport element containing the registration page of the user's passport.

PassportElementTypePassportRegistrationBuilder
PassportElementTypePersonalDetails

A Telegram Passport element containing the user's personal details.

PassportElementTypePersonalDetailsBuilder
PassportElementTypePhoneNumber

A Telegram Passport element containing the user's phone number.

PassportElementTypePhoneNumberBuilder
PassportElementTypeRentalAgreement

A Telegram Passport element containing the user's rental agreement.

PassportElementTypeRentalAgreementBuilder
PassportElementTypeTemporaryRegistration

A Telegram Passport element containing the user's temporary registration.

PassportElementTypeTemporaryRegistrationBuilder
PassportElementTypeUtilityBill

A Telegram Passport element containing the user's utility bill.

PassportElementTypeUtilityBillBuilder
PassportElementUtilityBill

A Telegram Passport element containing the user's utility bill.

PassportElementUtilityBillBuilder
PassportElements

Contains information about saved Telegram Passport elements.

PassportElementsBuilder
PassportElementsWithErrors

Contains information about a Telegram Passport elements and corresponding errors.

PassportElementsWithErrorsBuilder
PassportRequiredElement

Contains a description of the required Telegram Passport element that was requested by a service.

PassportRequiredElementBuilder
PassportSuitableElement

Contains information about a Telegram Passport element that was requested by a service.

PassportSuitableElementBuilder
PasswordState

Represents the current state of 2-step verification.

PasswordStateBuilder
PaymentForm

Contains information about an invoice payment form.

PaymentFormBuilder
PaymentReceipt

Contains information about a successful payment.

PaymentReceiptBuilder
PaymentResult

Contains the result of a payment request.

PaymentResultBuilder
PaymentsProviderStripe

Stripe payment provider.

PaymentsProviderStripeBuilder
PersonalDetails

Contains the user's personal details.

PersonalDetailsBuilder
PersonalDocument

A personal document, containing some information about a user.

PersonalDocumentBuilder
Photo

Describes a photo.

PhotoBuilder
PhotoSize

Photo description.

PhotoSizeBuilder
PinChatMessage

Pins a message in a chat; requires appropriate administrator rights in the group or channel.

PinChatMessageBuilder
PingProxy

Computes time needed to receive a response from a Telegram server through a proxy. Can be called before authorization.

PingProxyBuilder
Poll

Describes a poll.

PollBuilder
PollOption

Describes one answer option of a poll.

PollOptionBuilder
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.

ProcessPushNotificationBuilder
ProfilePhoto

Describes a user profile photo.

ProfilePhotoBuilder
Proxies

Represents a list of proxy servers.

ProxiesBuilder
Proxy

Contains information about a proxy server.

ProxyBuilder
ProxyTypeHttp

A HTTP transparent proxy server.

ProxyTypeHttpBuilder
ProxyTypeMtproto

An MTProto proxy server.

ProxyTypeMtprotoBuilder
ProxyTypeSocks5

A SOCKS5 proxy server.

ProxyTypeSocks5Builder
PublicMessageLink

Contains a public HTTPS link to a message in a public supergroup or channel.

PublicMessageLinkBuilder
PushMessageContentAnimation

An animation message (GIF-style.)

PushMessageContentAnimationBuilder
PushMessageContentAudio

An audio message.

PushMessageContentAudioBuilder
PushMessageContentBasicGroupChatCreate

A newly created basic group.

PushMessageContentBasicGroupChatCreateBuilder
PushMessageContentChatAddMembers

New chat members were invited to a group.

PushMessageContentChatAddMembersBuilder
PushMessageContentChatChangePhoto

A chat photo was edited.

PushMessageContentChatChangePhotoBuilder
PushMessageContentChatChangeTitle

A chat title was edited.

PushMessageContentChatChangeTitleBuilder
PushMessageContentChatDeleteMember

A chat member was deleted.

PushMessageContentChatDeleteMemberBuilder
PushMessageContentChatJoinByLink

A new member joined the chat by invite link.

PushMessageContentChatJoinByLinkBuilder
PushMessageContentContact

A message with a user contact.

PushMessageContentContactBuilder
PushMessageContentContactRegistered

A contact has registered with Telegram.

PushMessageContentContactRegisteredBuilder
PushMessageContentDocument

A document message (a general file).

PushMessageContentDocumentBuilder
PushMessageContentGame

A message with a game.

PushMessageContentGameBuilder
PushMessageContentGameScore

A new high score was achieved in a game.

PushMessageContentGameScoreBuilder
PushMessageContentHidden

A general message with hidden content.

PushMessageContentHiddenBuilder
PushMessageContentInvoice

A message with an invoice from a bot.

PushMessageContentInvoiceBuilder
PushMessageContentLocation

A message with a location.

PushMessageContentLocationBuilder
PushMessageContentMediaAlbum

A media album.

PushMessageContentMediaAlbumBuilder
PushMessageContentMessageForwards

A forwarded messages.

PushMessageContentMessageForwardsBuilder
PushMessageContentPhoto

A photo message.

PushMessageContentPhotoBuilder
PushMessageContentPoll

A message with a poll.

PushMessageContentPollBuilder
PushMessageContentScreenshotTaken

A screenshot of a message in the chat has been taken.

PushMessageContentScreenshotTakenBuilder
PushMessageContentSticker

A message with a sticker.

PushMessageContentStickerBuilder
PushMessageContentText

A text message.

PushMessageContentTextBuilder
PushMessageContentVideo

A video message.

PushMessageContentVideoBuilder
PushMessageContentVideoNote

A video note message.

PushMessageContentVideoNoteBuilder
PushMessageContentVoiceNote

A voice note message.

PushMessageContentVoiceNoteBuilder
PushReceiverId

Contains a globally unique push receiver identifier, which can be used to identify which account has received a push notification.

PushReceiverIdBuilder
ReadAllChatMentions

Marks all mentions in a chat as read.

ReadAllChatMentionsBuilder
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.

ReadFilePartBuilder
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

RecoverAuthenticationPasswordBuilder
RecoverPassword

Recovers the password using a recovery code sent to an email address that was previously set up.

RecoverPasswordBuilder
RecoveryEmailAddress

Contains information about the current recovery email address.

RecoveryEmailAddressBuilder
RegisterDevice

Registers the currently used device for receiving push notifications. Returns a globally unique identifier of the push notification subscription.

RegisterDeviceBuilder
RemoteFile

Represents a remote file.

RemoteFileBuilder
RemoveContacts

Removes users from the contact list.

RemoveContactsBuilder
RemoveFavoriteSticker

Removes a sticker from the list of favorite stickers.

RemoveFavoriteStickerBuilder
RemoveNotification

Removes an active notification from notification list. Needs to be called only if the notification is removed by the current user.

RemoveNotificationBuilder
RemoveNotificationGroup

Removes a group of active notifications. Needs to be called only if the notification group is removed by the current user.

RemoveNotificationGroupBuilder
RemoveProxy

Removes a proxy server. Can be called before authorization.

RemoveProxyBuilder
RemoveRecentHashtag

Removes a hashtag from the list of recently used hashtags.

RemoveRecentHashtagBuilder
RemoveRecentSticker

Removes a sticker from the list of recently used stickers.

RemoveRecentStickerBuilder
RemoveRecentlyFoundChat

Removes a chat from the list of recently found chats.

RemoveRecentlyFoundChatBuilder
RemoveSavedAnimation

Removes an animation from the list of saved animations.

RemoveSavedAnimationBuilder
RemoveStickerFromSet

Removes a sticker from the set to which it belongs; for bots only. The sticker set must have been created by the bot.

RemoveStickerFromSetBuilder
RemoveTopChat

Removes a chat from the list of frequently used chats. Supported only if the chat info database is enabled.

RemoveTopChatBuilder
ReorderInstalledStickerSets

Changes the order of installed sticker sets.

ReorderInstalledStickerSetsBuilder
ReplyMarkupForceReply

Instructs clients to force a reply to this message.

ReplyMarkupForceReplyBuilder
ReplyMarkupInlineKeyboard

Contains an inline keyboard layout.

ReplyMarkupInlineKeyboardBuilder
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.

ReplyMarkupRemoveKeyboardBuilder
ReplyMarkupShowKeyboard

Contains a custom keyboard layout to quickly reply to bots.

ReplyMarkupShowKeyboardBuilder
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.

ReportChatBuilder
ReportSupergroupSpam

Reports some messages from a user in a supergroup as spam; requires administrator rights in the supergroup.

ReportSupergroupSpamBuilder
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

RequestAuthenticationPasswordRecoveryBuilder
RequestPasswordRecovery

Requests to send a password recovery code to an email address that was previously set up.

RequestPasswordRecoveryBuilder
ResendAuthenticationCode

Re-sends an authentication code to the user. Works only when the current authorization state is

ResendAuthenticationCodeBuilder
ResendChangePhoneNumberCode

Re-sends the authentication code sent to confirm a new phone number for the user. Works only if the previously received

ResendChangePhoneNumberCodeBuilder
ResendEmailAddressVerificationCode

Re-sends the code to verify an email address to be added to a user's Telegram Passport.

ResendEmailAddressVerificationCodeBuilder
ResendPhoneNumberConfirmationCode

Resends phone number confirmation code.

ResendPhoneNumberConfirmationCodeBuilder
ResendPhoneNumberVerificationCode

Re-sends the code to verify a phone number to be added to a user's Telegram Passport.

ResendPhoneNumberVerificationCodeBuilder
ResendRecoveryEmailAddressCode

Resends the 2-step verification recovery email address verification code.

ResendRecoveryEmailAddressCodeBuilder
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.

ResetAllNotificationSettingsBuilder
ResetNetworkStatistics

Resets all network data usage statistics to zero. Can be called before authorization.

ResetNetworkStatisticsBuilder
RichTextAnchor

A rich text anchor.

RichTextAnchorBuilder
RichTextBold

A bold rich text.

RichTextBoldBuilder
RichTextEmailAddress

A rich text email link.

RichTextEmailAddressBuilder
RichTextFixed

A fixed-width rich text.

RichTextFixedBuilder
RichTextIcon

A small image inside the text.

RichTextIconBuilder
RichTextItalic

An italicized rich text.

RichTextItalicBuilder
RichTextMarked

A marked rich text.

RichTextMarkedBuilder
RichTextPhoneNumber

A rich text phone number.

RichTextPhoneNumberBuilder
RichTextPlain

A plain text.

RichTextPlainBuilder
RichTextStrikethrough

A strike-through rich text.

RichTextStrikethroughBuilder
RichTextSubscript

A subscript rich text.

RichTextSubscriptBuilder
RichTextSuperscript

A superscript rich text.

RichTextSuperscriptBuilder
RichTextUnderline

An underlined rich text.

RichTextUnderlineBuilder
RichTextUrl

A rich text URL link.

RichTextUrlBuilder
RichTexts

A concatenation of rich texts.

RichTextsBuilder
SavedCredentials

Contains information about saved card credentials.

SavedCredentialsBuilder
ScopeNotificationSettings

Contains information about notification settings for several chats.

ScopeNotificationSettingsBuilder
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.

SearchCallMessagesBuilder
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.

SearchChatMembersBuilder
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 (

SearchChatMessagesBuilder
SearchChatRecentLocationMessages

Returns information about the recent locations of chat members that were sent to the chat. Returns up to 1 location message per user.

SearchChatRecentLocationMessagesBuilder
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.

SearchChatsBuilder
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.

SearchChatsOnServerBuilder
SearchContacts

Searches for the specified query in the first names, last names and usernames of the known user contacts.

SearchContactsBuilder
SearchHashtags

Searches for recently used hashtags by their prefix.

SearchHashtagsBuilder
SearchInstalledStickerSets

Searches for installed sticker sets by looking for specified query in their title and name.

SearchInstalledStickerSetsBuilder
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.

SearchMessagesBuilder
SearchMessagesFilterAnimation

Returns only animation messages.

SearchMessagesFilterAnimationBuilder
SearchMessagesFilterAudio

Returns only audio messages.

SearchMessagesFilterAudioBuilder
SearchMessagesFilterCall

Returns only call messages.

SearchMessagesFilterCallBuilder
SearchMessagesFilterChatPhoto

Returns only messages containing chat photos.

SearchMessagesFilterChatPhotoBuilder
SearchMessagesFilterDocument

Returns only document messages.

SearchMessagesFilterDocumentBuilder
SearchMessagesFilterEmpty

Returns all found messages, no filter is applied.

SearchMessagesFilterEmptyBuilder
SearchMessagesFilterMention

Returns only messages with mentions of the current user, or messages that are replies to their messages.

SearchMessagesFilterMentionBuilder
SearchMessagesFilterMissedCall

Returns only incoming call messages with missed/declined discard reasons.

SearchMessagesFilterMissedCallBuilder
SearchMessagesFilterPhoto

Returns only photo messages.

SearchMessagesFilterPhotoAndVideo

Returns only photo and video messages.

SearchMessagesFilterPhotoAndVideoBuilder
SearchMessagesFilterPhotoBuilder
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.

SearchMessagesFilterUnreadMentionBuilder
SearchMessagesFilterUrl

Returns only messages containing URLs.

SearchMessagesFilterUrlBuilder
SearchMessagesFilterVideo

Returns only video messages.

SearchMessagesFilterVideoBuilder
SearchMessagesFilterVideoNote

Returns only video note messages.

SearchMessagesFilterVideoNoteBuilder
SearchMessagesFilterVoiceAndVideoNote

Returns only voice and video note messages.

SearchMessagesFilterVoiceAndVideoNoteBuilder
SearchMessagesFilterVoiceNote

Returns only voice note messages.

SearchMessagesFilterVoiceNoteBuilder
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.

SearchPublicChatBuilder
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.

SearchPublicChatsBuilder
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.

SearchSecretMessagesBuilder
SearchStickerSet

Searches for a sticker set by its name.

SearchStickerSetBuilder
SearchStickerSets

Searches for ordinary sticker sets by looking for specified query in their title and name. Excludes installed sticker sets from the results.

SearchStickerSetsBuilder
SearchStickers

Searches for stickers from public sticker sets that correspond to a given emoji.

SearchStickersBuilder
Seconds

Contains a value representing a number of seconds.

SecondsBuilder
SecretChat

Represents a secret chat.

SecretChatBuilder
SecretChatStateClosed

The secret chat is closed.

SecretChatStateClosedBuilder
SecretChatStatePending

The secret chat is not yet created; waiting for the other user to get online.

SecretChatStatePendingBuilder
SecretChatStateReady

The secret chat is ready to use.

SecretChatStateReadyBuilder
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.

SendBotStartMessageBuilder
SendCallDebugInformation

Sends debug information for a call.

SendCallDebugInformationBuilder
SendCallRating

Sends a call rating.

SendCallRatingBuilder
SendChatAction

Sends a notification about user activity in a chat.

SendChatActionBuilder
SendChatScreenshotTakenNotification

Sends a notification about a screenshot taken in a chat. Supported only in private and secret chats.

SendChatScreenshotTakenNotificationBuilder
SendChatSetTtlMessage

Changes the current TTL setting (sets a new self-destruct timer) in a secret chat and sends the corresponding message.

SendChatSetTtlMessageBuilder
SendCustomRequest

Sends a custom request; for bots only.

SendCustomRequestBuilder
SendEmailAddressVerificationCode

Sends a code to verify an email address to be added to a user's Telegram Passport.

SendEmailAddressVerificationCodeBuilder
SendInlineQueryResultMessage

Sends the result of an inline query as a message. Returns the sent message. Always clears a chat draft message.

SendInlineQueryResultMessageBuilder
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.

SendMessageAlbumBuilder
SendMessageBuilder
SendPassportAuthorizationForm

Sends a Telegram Passport authorization form, effectively sharing data with the service. This method must be called after

SendPassportAuthorizationFormBuilder
SendPaymentForm

Sends a filled-out payment form to the bot for final verification.

SendPaymentFormBuilder
SendPhoneNumberConfirmationCode

Sends phone number confirmation code. Should be called when user presses "

SendPhoneNumberConfirmationCodeBuilder
SendPhoneNumberVerificationCode

Sends a code to verify a phone number to be added to a user's Telegram Passport.

SendPhoneNumberVerificationCodeBuilder
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.

SessionBuilder
Sessions

Contains a list of sessions.

SessionsBuilder
SetAccountTtl

Changes the period of inactivity after which the account of the current user will automatically be deleted.

SetAccountTtlBuilder
SetAlarm

Succeeds after a specified amount of time has passed. Can be called before authorization. Can be called before initialization.

SetAlarmBuilder
SetAuthenticationPhoneNumber

Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is

SetAuthenticationPhoneNumberBuilder
SetBio

Changes the bio of the current user.

SetBioBuilder
SetBotUpdatesStatus

Informs the server about the number of pending bot updates if they haven't been processed for a long time; for bots only.

SetBotUpdatesStatusBuilder
SetChatClientData

Changes client data associated with a chat.

SetChatClientDataBuilder
SetChatDraftMessage

Changes the draft message in a chat.

SetChatDraftMessageBuilder
SetChatMemberStatus

Changes the status of a chat member, needs appropriate privileges. This function is currently not suitable for adding new members to the chat; instead, use

SetChatMemberStatusBuilder
SetChatNotificationSettings

Changes the notification settings of a chat.

SetChatNotificationSettingsBuilder
SetChatPhoto

Changes the photo of a chat. Supported only for basic groups, supergroups and channels. Requires administrator rights in basic groups and the appropriate administrator rights in supergroups and channels. The photo will not be changed before request to the server has been completed.

SetChatPhotoBuilder
SetChatTitle

Changes the chat title. Supported only for basic groups, supergroups and channels. Requires administrator rights in basic groups and the appropriate administrator rights in supergroups and channels. The title will not be changed until the request to the server has been completed.

SetChatTitleBuilder
SetCustomLanguagePack

Adds or changes a custom local language pack to the current localization target.

SetCustomLanguagePackBuilder
SetCustomLanguagePackString

Adds, edits or deletes a string in a custom local language pack. Can be called before authorization.

SetCustomLanguagePackStringBuilder
SetDatabaseEncryptionKey

Changes the database encryption key. Usually the encryption key is never changed and is stored in some OS keychain.

SetDatabaseEncryptionKeyBuilder
SetFileGenerationProgress

Informs TDLib on a file generation prograss.

SetFileGenerationProgressBuilder
SetGameScore

Updates the game score of the specified user in the game; for bots only.

SetGameScoreBuilder
SetInlineGameScore

Updates the game score of the specified user in a game; for bots only.

SetInlineGameScoreBuilder
SetLogStream

Sets new log stream for internal logging of TDLib. This is an offline method. Can be called before authorization. Can be called synchronously.

SetLogStreamBuilder
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.

SetLogTagVerbosityLevelBuilder
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.

SetLogVerbosityLevelBuilder
SetName

Changes the first and last name of the current user. If something changes,

SetNameBuilder
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.

SetNetworkTypeBuilder
SetOption

Sets the value of an option. (Check the list of available options on

SetOptionBuilder
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.

SetPassportElementBuilder
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.

SetPassportElementErrorsBuilder
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.

SetPasswordBuilder
SetPinnedChats

Changes the order of pinned chats.

SetPinnedChatsBuilder
SetPollAnswer

Changes user answer to a poll.

SetPollAnswerBuilder
SetProfilePhoto

Uploads a new profile photo for the current user. If something changes,

SetProfilePhotoBuilder
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.

SetRecoveryEmailAddressBuilder
SetScopeNotificationSettings

Changes notification settings for chats of a given type.

SetScopeNotificationSettingsBuilder
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.

SetStickerPositionInSetBuilder
SetSupergroupDescription

Changes information about a supergroup or channel; requires appropriate administrator rights.

SetSupergroupDescriptionBuilder
SetSupergroupStickerSet

Changes the sticker set of a supergroup; requires appropriate rights in the supergroup.

SetSupergroupStickerSetBuilder
SetSupergroupUsername

Changes the username of a supergroup or channel, requires creator privileges in the supergroup or channel.

SetSupergroupUsernameBuilder
SetTdlibParameters

Sets the parameters for TDLib initialization. Works only when the current authorization state is

SetTdlibParametersBuilder
SetUserPrivacySettingRules

Changes user privacy settings.

SetUserPrivacySettingRulesBuilder
SetUsername

Changes the username of the current user. If something changes,

SetUsernameBuilder
ShippingOption

One shipping option.

ShippingOptionBuilder
Sticker

Describes a sticker.

StickerBuilder
StickerEmojis

Represents a list of all emoji corresponding to a sticker in a sticker set. The list is only for informational purposes, because a sticker is always sent with a fixed emoji from the corresponding Sticker object.

StickerEmojisBuilder
StickerSet

Represents a sticker set.

StickerSetBuilder
StickerSetInfo

Represents short information about a sticker set.

StickerSetInfoBuilder
StickerSets

Represents a list of sticker sets.

StickerSetsBuilder
Stickers

Represents a list of stickers.

StickersBuilder
StopPoll

Stops a poll. A poll in a message can be stopped when the message has can_be_edited flag set.

StopPollBuilder
StorageStatistics

Contains the exact storage usage statistics split by chats and file type.

StorageStatisticsBuilder
StorageStatisticsByChat

Contains the storage usage statistics for a specific chat.

StorageStatisticsByChatBuilder
StorageStatisticsByFileType

Contains the storage usage statistics for a specific file type.

StorageStatisticsByFileTypeBuilder
StorageStatisticsFast

Contains approximate storage usage statistics, excluding files of unknown file type.

StorageStatisticsFastBuilder
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.

SupergroupBuilder
SupergroupFullInfo

Contains full information about a supergroup or channel.

SupergroupFullInfoBuilder
SupergroupMembersFilterAdministrators

Returns the creator and administrators.

SupergroupMembersFilterAdministratorsBuilder
SupergroupMembersFilterBanned

Returns users banned from the supergroup or channel; can be used only by administrators.

SupergroupMembersFilterBannedBuilder
SupergroupMembersFilterBots

Returns bot members of the supergroup or channel.

SupergroupMembersFilterBotsBuilder
SupergroupMembersFilterRecent

Returns recently active users in reverse chronological order.

SupergroupMembersFilterRecentBuilder
SupergroupMembersFilterRestricted

Returns restricted supergroup members; can be used only by administrators.

SupergroupMembersFilterRestrictedBuilder
SupergroupMembersFilterSearch

Used to search for supergroup or channel members via a (string) query.

SupergroupMembersFilterSearchBuilder
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.

SynchronizeLanguagePackBuilder
TMeUrl

Represents a URL linking to an internal Telegram entity.

TMeUrlBuilder
TMeUrlTypeChatInvite

A chat invite link.

TMeUrlTypeChatInviteBuilder
TMeUrlTypeStickerSet

A URL linking to a sticker set.

TMeUrlTypeStickerSetBuilder
TMeUrlTypeSupergroup

A URL linking to a public supergroup or channel.

TMeUrlTypeSupergroupBuilder
TMeUrlTypeUser

A URL linking to a user.

TMeUrlTypeUserBuilder
TMeUrls

Contains a list of t.me URLs.

TMeUrlsBuilder
TdlibParameters

Contains parameters for TDLib initialization.

TdlibParametersBuilder
TemporaryPasswordState

Returns information about the availability of a temporary password, which can be used for payments.

TemporaryPasswordStateBuilder
TerminateAllOtherSessions

Terminates all other sessions of the current user.

TerminateAllOtherSessionsBuilder
TerminateSession

Terminates a session of the current user.

TerminateSessionBuilder
TermsOfService

Contains Telegram terms of service.

TermsOfServiceBuilder
TestBytes

A simple object containing a sequence of bytes; for testing only.

TestBytesBuilder
TestCallBytes

Returns the received bytes; for testing only. This is an offline method. Can be called before authorization.

TestCallBytesBuilder
TestCallEmpty

Does nothing; for testing only. This is an offline method. Can be called before authorization.

TestCallEmptyBuilder
TestCallString

Returns the received string; for testing only. This is an offline method. Can be called before authorization.

TestCallStringBuilder
TestCallVectorInt

Returns the received vector of numbers; for testing only. This is an offline method. Can be called before authorization.

TestCallVectorIntBuilder
TestCallVectorIntObject

Returns the received vector of objects containing a number; for testing only. This is an offline method. Can be called before authorization.

TestCallVectorIntObjectBuilder
TestCallVectorString

Returns the received vector of strings; for testing only. This is an offline method. Can be called before authorization.

TestCallVectorStringBuilder
TestCallVectorStringObject

Returns the received vector of objects containing a string; for testing only. This is an offline method. Can be called before authorization.

TestCallVectorStringObjectBuilder
TestGetDifference

Forces an updates.getDifference call to the Telegram servers; for testing only.

TestGetDifferenceBuilder
TestInt

A simple object containing a number; for testing only.

TestIntBuilder
TestNetwork

Sends a simple network request to the Telegram servers; for testing only. Can be called before authorization.

TestNetworkBuilder
TestSquareInt

Returns the squared received number; for testing only. This is an offline method. Can be called before authorization.

TestSquareIntBuilder
TestString

A simple object containing a string; for testing only.

TestStringBuilder
TestUseError

Does nothing and ensures that the Error object is used; for testing only. This is an offline method. Can be called before authorization.

TestUseErrorBuilder
TestUseUpdate

Does nothing and ensures that the

TestUseUpdateBuilder
TestVectorInt

A simple object containing a vector of numbers; for testing only.

TestVectorIntBuilder
TestVectorIntObject

A simple object containing a vector of objects that hold a number; for testing only.

TestVectorIntObjectBuilder
TestVectorString

A simple object containing a vector of strings; for testing only.

TestVectorStringBuilder
TestVectorStringObject

A simple object containing a vector of objects that hold a string; for testing only.

TestVectorStringObjectBuilder
Text

Contains some text.

TextBuilder
TextEntities

Contains a list of text entities.

TextEntitiesBuilder
TextEntity

Represents a part of the text that needs to be formatted in some unusual way.

TextEntityBuilder
TextEntityTypeBold

A bold text.

TextEntityTypeBoldBuilder
TextEntityTypeBotCommand

A bot command, beginning with "/". This shouldn't be highlighted if there are no bots in the chat.

TextEntityTypeBotCommandBuilder
TextEntityTypeCashtag

A cashtag text, beginning with "$" and consisting of capital english letters (i.e. "$USD").

TextEntityTypeCashtagBuilder
TextEntityTypeCode

Text that must be formatted as if inside a code HTML tag.

TextEntityTypeCodeBuilder
TextEntityTypeEmailAddress

An email address.

TextEntityTypeEmailAddressBuilder
TextEntityTypeHashtag

A hashtag text, beginning with "#".

TextEntityTypeHashtagBuilder
TextEntityTypeItalic

An italic text.

TextEntityTypeItalicBuilder
TextEntityTypeMention

A mention of a user by their username.

TextEntityTypeMentionBuilder
TextEntityTypeMentionName

A text shows instead of a raw mention of the user (e.g., when the user has no username).

TextEntityTypeMentionNameBuilder
TextEntityTypePhoneNumber

A phone number.

TextEntityTypePhoneNumberBuilder
TextEntityTypePre

Text that must be formatted as if inside a pre HTML tag.

TextEntityTypePreBuilder
TextEntityTypePreCode

Text that must be formatted as if inside pre, and code HTML tags.

TextEntityTypePreCodeBuilder
TextEntityTypeTextUrl

A text description shown instead of a raw URL.

TextEntityTypeTextUrlBuilder
TextEntityTypeUrl

An HTTP URL.

TextEntityTypeUrlBuilder
TextParseModeHTML

The text should be parsed in HTML-style.

TextParseModeHTMLBuilder
TextParseModeMarkdown

The text should be parsed in markdown-style.

TextParseModeMarkdownBuilder
ToggleBasicGroupAdministrators

Toggles the "All members are admins" setting in basic groups; requires creator privileges in the group.

ToggleBasicGroupAdministratorsBuilder
ToggleChatDefaultDisableNotification

Changes the value of the default disable_notification parameter, used when a message is sent to a chat.

ToggleChatDefaultDisableNotificationBuilder
ToggleChatIsMarkedAsUnread

Changes the marked as unread state of a chat.

ToggleChatIsMarkedAsUnreadBuilder
ToggleChatIsPinned

Changes the pinned state of a chat. You can pin up to GetOption("pinned_chat_count_max") non-secret chats and the same number of secret chats.

ToggleChatIsPinnedBuilder
ToggleSupergroupInvites

Toggles whether all members of a supergroup can add new members; requires appropriate administrator rights in the supergroup.

ToggleSupergroupInvitesBuilder
ToggleSupergroupIsAllHistoryAvailable

Toggles whether the message history of a supergroup is available to new members; requires appropriate administrator rights in the supergroup.

ToggleSupergroupIsAllHistoryAvailableBuilder
ToggleSupergroupSignMessages

Toggles sender signatures messages sent in a channel; requires appropriate administrator rights in the channel.

ToggleSupergroupSignMessagesBuilder
TopChatCategoryBots

A category containing frequently used private chats with bot users.

TopChatCategoryBotsBuilder
TopChatCategoryCalls

A category containing frequently used chats used for calls.

TopChatCategoryCallsBuilder
TopChatCategoryChannels

A category containing frequently used channels.

TopChatCategoryChannelsBuilder
TopChatCategoryGroups

A category containing frequently used basic groups and supergroups.

TopChatCategoryGroupsBuilder
TopChatCategoryInlineBots

A category containing frequently used chats with inline bots sorted by their usage in inline mode.

TopChatCategoryInlineBotsBuilder
TopChatCategoryUsers

A category containing frequently used private chats with non-bot users.

TopChatCategoryUsersBuilder
UnblockUser

Removes a user from the blacklist.

UnblockUserBuilder
UnpinChatMessage

Removes the pinned message from a chat; requires appropriate administrator rights in the group or channel.

UnpinChatMessageBuilder
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

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

UpdateCall

New call was created or information about a call was updated.

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.

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

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

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

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.

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

UpdateTermsOfService

New terms of service must be accepted by the user. If the terms of service are declined, then the

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 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

UpdateUserPrivacySettingRules

Some privacy setting rules have been changed.

UpdateUserStatus

The user went online or offline.

Updates

Contains a list of updates.

UpdatesBuilder
UpgradeBasicGroupChatToSupergroupChat

Creates a new supergroup from an existing basic group and sends a corresponding

UpgradeBasicGroupChatToSupergroupChatBuilder
UploadFile

Asynchronously uploads a file to the cloud without sending it in a message.

UploadFileBuilder
UploadStickerFile

Uploads a PNG image with a sticker; for bots only; returns the uploaded file.

UploadStickerFileBuilder
User

Represents a user.

UserBuilder
UserFullInfo

Contains full information about a user (except the full list of profile photos).

UserFullInfoBuilder
UserPrivacySettingAllowCalls

A privacy setting for managing whether the user can be called.

UserPrivacySettingAllowCallsBuilder
UserPrivacySettingAllowChatInvites

A privacy setting for managing whether the user can be invited to chats.

UserPrivacySettingAllowChatInvitesBuilder
UserPrivacySettingAllowPeerToPeerCalls

A privacy setting for managing whether peer-to-peer connections can be used for calls.

UserPrivacySettingAllowPeerToPeerCallsBuilder
UserPrivacySettingRuleAllowAll

A rule to allow all users to do something.

UserPrivacySettingRuleAllowAllBuilder
UserPrivacySettingRuleAllowContacts

A rule to allow all of a user's contacts to do something.

UserPrivacySettingRuleAllowContactsBuilder
UserPrivacySettingRuleAllowUsers

A rule to allow certain specified users to do something.

UserPrivacySettingRuleAllowUsersBuilder
UserPrivacySettingRuleRestrictAll

A rule to restrict all users from doing something.

UserPrivacySettingRuleRestrictAllBuilder
UserPrivacySettingRuleRestrictContacts

A rule to restrict all contacts of a user from doing something.

UserPrivacySettingRuleRestrictContactsBuilder
UserPrivacySettingRuleRestrictUsers

A rule to restrict all specified users from doing something.

UserPrivacySettingRuleRestrictUsersBuilder
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.

UserPrivacySettingRulesBuilder
UserPrivacySettingShowStatus

A privacy setting for managing whether the user's online status is visible.

UserPrivacySettingShowStatusBuilder
UserProfilePhoto

Contains full information about a user profile photo.

UserProfilePhotoBuilder
UserProfilePhotos

Contains part of the list of user photos.

UserProfilePhotosBuilder
UserStatusEmpty

The user status was never changed.

UserStatusEmptyBuilder
UserStatusLastMonth

The user is offline, but was online last month.

UserStatusLastMonthBuilder
UserStatusLastWeek

The user is offline, but was online last week.

UserStatusLastWeekBuilder
UserStatusOffline

The user is offline.

UserStatusOfflineBuilder
UserStatusOnline

The user is online.

UserStatusOnlineBuilder
UserStatusRecently

The user was online recently.

UserStatusRecentlyBuilder
UserTypeBot

A bot (see

UserTypeBotBuilder
UserTypeDeleted

A deleted user or deleted bot. No information on the user besides the user_id is available. It is not possible to perform any active actions on this type of user.

UserTypeDeletedBuilder
UserTypeRegular

A regular user.

UserTypeRegularBuilder
UserTypeUnknown

No information on the user besides the user_id 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.

UserTypeUnknownBuilder
Users

Represents a list of users.

UsersBuilder
ValidateOrderInfo

Validates the order information provided by a user and returns the available shipping options for a flexible invoice.

ValidateOrderInfoBuilder
ValidatedOrderInfo

Contains a temporary identifier of validated order information, which is stored for one hour. Also contains the available shipping options.

ValidatedOrderInfoBuilder
Venue

Describes a venue.

VenueBuilder
Video

Describes a video file.

VideoBuilder
VideoNote

Describes a video note. The video must be equal in width and height, cropped to a circle, and stored in MPEG4 format.

VideoNoteBuilder
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).

ViewMessagesBuilder
ViewTrendingStickerSets

Informs the server that some trending sticker sets have been viewed by the user.

ViewTrendingStickerSetsBuilder
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.

VoiceNoteBuilder
Wallpaper

Contains information about a wallpaper.

WallpaperBuilder
Wallpapers

Contains a list of wallpapers.

WallpapersBuilder
WebPage

Describes a web page preview.

WebPageBuilder
WebPageInstantView

Describes an instant view page for a web page.

WebPageInstantViewBuilder
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.

WriteGeneratedFilePartBuilder

Traits

AuthenticationCodeType

This class is an abstract base class. Provides information about the method by which an authentication code is delivered to the user.

AuthorizationState

This class is an abstract base class. Represents the current authorization state of the client.

CallDiscardReason

This class is an abstract base class. Describes the reason why a call was discarded.

CallState

This class is an abstract base class. Describes the current call state.

CallbackQueryPayload

This class is an abstract base class. Represents a payload of a callback query.

ChatAction

This class is an abstract base class. Describes the different types of activity in a chat.

ChatEventAction

This class is an abstract base class. Represents a chat event.

ChatMemberStatus

This class is an abstract base class. Provides information about the status of a member in a chat.

ChatMembersFilter

This class is an abstract base class. Specifies the kind of chat members to return in

ChatReportReason

This class is an abstract base class. Describes the reason why a chat is reported.

ChatType

This class is an abstract base class. Describes the type of a chat.

CheckChatUsernameResult

This class is an abstract base class. Represents result of checking whether a username can be set for a chat.

ConnectionState

This class is an abstract base class. Describes the current state of the connection to Telegram servers.

DeviceToken

This class is an abstract base class. Represents a data needed to subscribe for push notifications through

FileType

This class is an abstract base class. Represents the type of a file.

Function

This class is a base class for all TDLib API functions.

InlineKeyboardButtonType

This class is an abstract base class. Describes the type of an inline keyboard button.

InlineQueryResult

This class is an abstract base class. Represents a single result of an inline query.

InputCredentials

This class is an abstract base class. Contains information about the payment method chosen by the user.

InputFile

This class is an abstract base class. Points to a file.

InputInlineQueryResult

This class is an abstract base class. Represents a single result of an inline query; for bots only.

InputMessageContent

This class is an abstract base class. The content of a message to send.

InputPassportElement

This class is an abstract base class. Contains information about a Telegram Passport element to be saved.

InputPassportElementErrorSource

This class is an abstract base class. Contains the description of an error in a Telegram Passport element; for bots only.

KeyboardButtonType

This class is an abstract base class. Describes a keyboard button type.

LanguagePackStringValue

This class is an abstract base class. Represents the value of a string in a language pack.

LinkState

This class is an abstract base class. Represents the relationship between user A and user B. For incoming_link, user A is the current user; for outgoing_link, user B is the current user.

LogStream

This class is an abstract base class. Describes a stream to which TDLib internal log is written.

MaskPoint

This class is an abstract base class. Part of the face, relative to which a mask should be placed.

MessageContent

This class is an abstract base class. Contains the content of a message.

MessageForwardOrigin

This class is an abstract base class. Contains information about the origin of a forwarded message.

MessageSendingState

This class is an abstract base class. Contains information about the sending state of the message.

NetworkStatisticsEntry

This class is an abstract base class. Contains statistics about network usage.

NetworkType

This class is an abstract base class. Represents the type of a network.

NotificationGroupType

This class is an abstract base class. Describes type of notifications in the group.

NotificationSettingsScope

This class is an abstract base class. Describes the types of chats to which notification settings are applied.

NotificationType

This class is an abstract base class. Contains detailed information about a notification.

Object

This class is a base class for all TDLib API classes.

OptionValue

This class is an abstract base class. Represents the value of an option.

PageBlock

This class is an abstract base class. Describes a block of an instant view web page.

PageBlockHorizontalAlignment

This class is an abstract base class. Describes a horizontal alignment of a table cell content.

PageBlockVerticalAlignment

This class is an abstract base class. Describes a Vertical alignment of a table cell content.

PassportElement

This class is an abstract base class. Contains information about a Telegram Passport element.

PassportElementErrorSource

This class is an abstract base class. Contains the description of an error in a Telegram Passport element.

PassportElementType

This class is an abstract base class. Contains the type of a Telegram Passport element.

ProxyType

This class is an abstract base class. Describes the type of the proxy server.

PushMessageContent

This class is an abstract base class. Contains content of a push message notification.

ReplyMarkup

This class is an abstract base class. Contains a description of a custom keyboard and actions that can be done with it to quickly reply to bots.

RichText

This class is an abstract base class. Describes a text object inside an instant-view web page.

SearchMessagesFilter

This class is an abstract base class. Represents a filter for message search results.

SecretChatState

This class is an abstract base class. Describes the current secret chat state.

SupergroupMembersFilter

This class is an abstract base class. Specifies the kind of chat members to return in

TMeUrlType

This class is an abstract base class. Describes the type of a URL linking to an internal Telegram entity.

TextEntityType

This class is an abstract base class. Represents a part of the text which must be formatted differently.

TextParseMode

This class is an abstract base class. Describes the way the text should be parsed for TextEntities.

TopChatCategory

This class is an abstract base class. Represents the categories of chats for which a list of frequently used chats can be retrieved.

Update

This class is an abstract base class. Contains notifications about data changes.

UserPrivacySetting

This class is an abstract base class. Describes available user privacy settings.

UserPrivacySettingRule

This class is an abstract base class. Represents a single rule for managing privacy settings.

UserStatus

This class is an abstract base class. Describes the last time the user was online.

UserType

This class is an abstract base class. Represents the type of the user. The following types are possible: regular users, deleted users and bots.