Changes in 1.7.0 (28 Nov 2020):
- Added a new simplified JSON interface in which updates and responses to requests from all TDLib instances
are received in the same thread:
- The TDLib instance is identified by the unique
client_id
identifier, which is returned by the methodtd_create_client_id
. - Use the method
td_send
to send a request to a specified client. The TDLib instance is created on the first request sent to it. - Use the method
td_receive
to receive updates and request responses from TDLib. The response will contain the identifier of the client from which the event was received in the field "@client_id". - Use the method
td_execute
to synchronously execute suitable TDLib methods.
- The TDLib instance is identified by the unique
- Added support for adding chats to more than one chat list:
- Added the class
chatPosition
, describing the position of the chat within a chat list. - Replaced the fields
chat_list
,order
,is_sponsored
andis_pinned
in the classchat
with the fieldpositions
, containing a list of the chat positions in various chat list. - Replaced the field
order
with the fieldpositions
in the updatesupdateChatLastMessage
andupdateChatDraftMessage
. - Added the update
updateChatPosition
. - Removed the superfluous updates
updateChatChatList
,updateChatIsSponsored
,updateChatOrder
andupdateChatIsPinned
. - Added the parameter
chat_list
to the methodtoggleChatIsPinned
. - Added the class
chatLists
, containing a list of chat lists. - Added the method
getChatListsToAddChat
, returning all chat lists to which a chat can be added. - Added the method
addChatToList
, which can be used to add a chat to a chat list. - Remove the method
setChatChatList
.
- Added the class
- Added support for chat filters:
- Added the new chat list type
chatListFilter
. - Added the classes
chatFilterInfo
andchatFilter
, describing a filter of user chats. - Added the update
updateChatFilters
, which is sent when the list of chat filters is changed. - Added the methods
createChatFilter
,editChatFilter
anddeleteChatFilter
for managing chat filters. - Added the method
reorderChatFilters
for changing the order of chat filters. - Added the method
getChatFilter
, returning full information about a chat filter. - Added the synchronous method
getChatFilterDefaultIconName
. - Added the classes
recommendedChatFilter
andrecommendedChatFilters
. - Added the method
getRecommendedChatFilters
, returning a list of recommended chat filters.
- Added the new chat list type
- Added support for messages sent on behalf of chats instead of users:
- Added the class
MessageSender
, representing a user or a chat which sent a message. - Added the class
MessageSenders
, representing a list of message senders. - Replaced the field
sender_user_id
with the fieldsender
of the typeMessageSender
in the classesmessage
andnotificationTypeNewPushMessage
. - Added the class
messageForwardOriginChat
, which describe a chat as the original sender of a message. - Added the ability to search messages sent by a chat by replacing the parameter
sender_user_id
with the parametersender
of the typeMessageSender
in the methodsearchChatMessages
. - Added the ability to specify a chat as a local message sender by replacing the parameter
sender_user_id
with the parametersender
of the typeMessageSender
in the methodaddLocalMessage
.
- Added the class
- Added support for video calls:
- Added the class
callServer
, describing a server for relaying call data. - Added the classes
callServerTypeTelegramReflector
andcallServerTypeWebrtc
, representing different types of supported call servers. - Replaced the field
connections
with the fieldservers
in the classcallStateReady
. - Removed the class
callConnection
. - Added the update
updateNewCallSignalingData
. - Added the method
sendCallSignalingData
. - Added the field
supports_video_calls
to the classuserFullInfo
. - Added the field
is_video
to the classmessageCall
. - Added the field
is_video
to the classcall
. - Added the parameter
is_video
to the methodcreateCall
. - Added the parameter
is_video
to the methoddiscardCall
. - Added two new types of call problems
callProblemDistortedVideo
andcallProblemPixelatedVideo
. - Added the field
library_versions
to the classcallProtocol
, which must be used to specify all supported call library versions.
- Added the class
- Added support for multiple pinned messages and the ability to pin messages in private chats:
- Added the ability to pin messages in all private chats.
- Added the ability to pin mutiple messages in all chats.
- Added the field
is_pinned
to the classmessage
. - Added the update
updateMessageIsPinned
. - Added the parameter
only_for_self
to the methodpinChatMessage
, allowing to pin messages in private chats for one side only. - Added the ability to find pinned messages in a chat using the filter
searchMessagesFilterPinned
. - Added the parameter
message_id
to the methodunpinChatMessage
. - Added the field
message
to the classchatEventMessageUnpinned
. - Added the method
unpinAllChatMessages
, which can be used to simultaneously unpin all pinned messages in a chat. - Documented that notifications about new pinned messages are always silent in channels and private chats.
- The method
getChatPinnedMessage
now returns the newest pinned message in the chat. - Removed the field
pinned_message_id
from the classchat
. - Removed the update
updateChatPinnedMessage
.
- Improved thumbnail representation and added support for animated MPEG4 thumbnails:
- Added the class
ThumbnailFormat
, representing the various supported thumbnail formats. - Added the class
thumbnail
, containing information about a thumbnail. - Changed the type of all thumbnail fields from
photoSize
tothumbnail
. - Added support for thumbnails in the format
thumbnailFormatMpeg4
for some animations and videos. - Replaced the classes
inputInlineQueryResultAnimatedGif
andinputInlineQueryResultAnimatedMpeg4
with the generic classinputInlineQueryResultAnimation
. - Added support for animated thumbnails in the class
inputInlineQueryResultAnimation
. - The class
photoSize
is now only used for JPEG images.
- Added the class
- Improved support for user profile photos and chat photos:
- Added the field
photo
to the classuserFullInfo
, containing full information about the user photo. - Added the field
photo
to the classbasicGroupFullInfo
, containing full information about the group photo. - Added the field
photo
to the classsupergroupFullInfo
, containing full information about the group photo. - Renamed the class
chatPhoto
tochatPhotoInfo
. - Added the field
has_animation
to the classesprofilePhoto
andchatPhotoInfo
, which is set to true for animated chat photos. - Added the classes
chatPhoto
andchatPhotos
. - Added minithumbnail support via the field
minithumbnail
in the classchatPhoto
. - Added the class
animatedChatPhoto
. - Added animated chat photo support via the field
animation
in the classchatPhoto
. - Removed the classes
userProfilePhoto
anduserProfilePhotos
. - Changed the type of the field
photo
in the classmessageChatChangePhoto
tochatPhoto
. - Changed the type of the fields
old_photo
andnew_photo
in the classchatEventPhotoChanged
tochatPhoto
. - Changed the return type of the method
getUserProfilePhotos
tochatPhotos
. - Added the class
InputChatPhoto
, representing a chat or a profile photo to set. - Changed the type of the parameter
photo
in the methodssetProfilePhoto
andsetChatPhoto
to theInputChatPhoto
. - Added the ability to explicitly re-use previously set profile photos using the class
inputChatPhotoPrevious
. - Added the ability to set animated chat photos using the class
inputChatPhotoAnimated
.
- Added the field
- Added support for message threads in supergroups and channel comments:
- Added the field
message_thread_id
to the classmessage
. - Added the class
messageThreadInfo
, containing information about a message thread. - Added the class
messageReplyInfo
, containing information about replies to a message. - Added the field
reply_info
to the classmessageInteractionInfo
, containing information about message replies. - Added the field
can_get_message_thread
to the classmessage
. - Added the method
getMessageThread
, returning information about the message thread to which a message belongs. - Added the method
getMessageThreadHistory
, returning messages belonging to a message thread. - Added the parameter
message_thread_id
to the methodssendMessage
,sendMessageAlbum
andsendInlineQueryResultMessage
for sending messages within a thread. - Added the parameter
message_thread_id
to the methodsearchChatMessages
to search messages within a thread. - Added the parameter
message_thread_id
to the methodviewMessages
. - Added the parameter
message_thread_id
to the methodsetChatDraftMessage
. - Added the parameter
message_thread_id
to the methodsendChatAction
to send chat actions to a thread. - Added the field
message_thread_id
to the updateupdateUserChatAction
.
- Added the field
- Improved support for message albums:
- Added support for sending and receiving messages of the types
messageAudio
andmessageDocument
as albums. - Added automatic grouping into audio or document albums in the method
forwardMessages
if all forwarded or copied messages are of the same type. - Removed the parameter
as_album
from the methodforwardMessages
. Forwarded message albums are now determined automatically.
- Added support for sending and receiving messages of the types
- Simplified usage of methods generating an HTTP link to a message:
- Added the class
messageLink
, representing an HTTP link to a message. - Combined the methods
getPublicMessageLink
andgetMessageLink
into the methodgetMessageLink
, which now returns a public link to the message if possible and a private link otherwise. The combined method is an offline method now. - Added the parameter
for_comment
to the methodgetMessageLink
, which allows to get a message link to the message that opens it in a thread. - Removed the class
publicMessageLink
. - Added the field
for_comment
to the classmessageLinkInfo
. - Added the separate method
getMessageEmbeddingCode
, returning an HTML code for embedding a message.
- Added the class
- Added the ability to block private messages sent via the @replies bot from chats:
- Added the field
is_blocked
to the classchat
. - Added the update
updateChatIsBlocked
. - Added the method
blockMessageSenderFromReplies
. - Replaced the methods
blockUser
andunblockUser
with the methodtoggleMessageSenderIsBlocked
. - Replaced the method
getBlockedUsers
with the methodgetBlockedMessageSenders
.
- Added the field
- Added support for incoming messages which are replies to messages in different chats:
- Added the field
reply_in_chat_id
to the classmessage
. - The method
getRepliedMessage
can now return the replied message in a different chat.
- Added the field
- Renamed the class
sendMessageOptions
tomessageSendOptions
. - Added the new
tdapi
static library, which needs to be additionally linked in when static linking is used. - Changed the type of the field
value
in the classoptionValueInteger
fromint32
toint64
. - Changed the type of the field
description
in the classwebPage
fromstring
toformattedText
. - Improved Instant View support:
- Added the field
view_count
to the classwebPageInstantView
. - Added the class
richTextAnchorLink
, containing a link to an anchor on the same page. - Added the class
richTextReference
, containing a reference to a text on the same page. - Removed the field
text
from the classrichTextAnchor
. - Removed the field
url
which is no longer needed from the classwebPageInstantView
.
- Added the field
- Allowed the update
updateServiceNotification
to be sent before authorization is completed. - Disallowed to pass messages in non-strictly increasing order to the method
forwardMessages
. - Improved sending copies of messages:
- Added the class
messageCopyOptions
and the fieldcopy_options
to the classinputMessageForwarded
. - Removed the fields
send_copy
andremove_caption
from the classinputMessageForwarded
. - Allowed to replace captions in copied messages using the fields
replace_caption
andnew_caption
in the classmessageCopyOptions
. - Allowed to specify
reply_to_message_id
when sending a copy of a message. - Allowed to specify
reply_markup
when sending a copy of a message.
- Added the class
- Allowed passing multiple input language codes to
searchEmojis
by replacing the parameterinput_language_code
with the parameterinput_language_codes
. - Added support for public service announcements:
- Added the class
ChatSource
and the fieldsource
to the classchatPosition
. - Added the new type of chat source
chatSourcePublicServiceAnnouncement
. - Added the field
public_service_announcement_type
to the classmessageForwardInfo
.
- Added the class
- Added support for previewing of private supergroups and channels by their invite link.
- The field
chat_id
in the classchatInviteLinkInfo
is now non-zero for private supergroups and channels to which the temporary read access is granted. - Added the field
accessible_for
to the classchatInviteLinkInfo
, containing the amount of time for which read access to the chat will remain available.
- The field
- Improved methods for message search:
- Replaced the field
next_from_search_id
with a string fieldnext_offset
in the classfoundMessages
. - Added the field
total_count
to the classfoundMessages
; can be -1 if the total count of matching messages is unknown. - Replaced the parameter
from_search_id
with the parameteroffset
in the methodsearchSecretMessages
. - Added the parameter
filter
to the methodsearchMessages
. - Added the parameters
min_date
andmax_date
to the methodsearchMessages
to search messages sent only within a particular timeframe.
- Replaced the field
- Added pkg-config file generation for all installed libraries.
- Added automatic operating system version detection. Use an empty field
system_version
in the classtdlibParameters
for the automatic detection. - Increased maximum file size from 1500 MB to 2000 MB.
- Added support for human-friendly Markdown formatting:
- Added the synchronous method
parseMarkdown
for human-friendly parsing of text entities. - Added the synchronous method
getMarkdownText
for replacing text entities with a human-friendly Markdown formatting. - Added the writable option "always_parse_markdown" which enables automatic parsing of text entities in
all
inputMessageText
objects.
- Added the synchronous method
- Added support for dice with random values in messages:
- Added the class
messageDice
to the types of message content; contains a dice. - Added the class
DiceStickers
, containing animated stickers needed to show the dice. - Added the class
inputMessageDice
to the types of new input message content; can be used to send a dice. - Added the update
updateDiceEmojis
, containing information about supported dice emojis.
- Added the class
- Added support for chat statistics in channels and supergroups:
- Added the field
can_get_statistics
to the classsupergroupFullInfo
. - Added the class
ChatStatistics
, which represents a supergroup or a channel statistics. - Added the method
getChatStatistics
returning detailed statistics about a chat. - Added the classes
chatStatisticsMessageInteractionInfo
,chatStatisticsAdministratorActionsInfo
,chatStatisticsMessageSenderInfo
andchatStatisticsInviterInfo
representing various parts of chat statistics. - Added the class
statisticalValue
describing recent changes of a statistical value. - Added the class
StatisticalGraph
describing a statistical graph. - Added the method
getStatisticalGraph
, which can be used for loading asynchronous or zoomed in statistical graphs. - Added the class
dateRange
representing a date range for which statistics are available. - Removed the field
can_view_statistics
from the classsupergroupFullInfo
and marked the methodgetChatStatisticsUrl
as disabled and not working.
- Added the field
- Added support for detailed statistics about interactions with messages:
- Added the class
messageInteractionInfo
, containing information about message views, forwards and replies. - Added the field
interaction_info
to the classmessage
. - Added the update
updateMessageInteractionInfo
. - Added the field
can_get_statistics
to the classmessage
. - Added the class
messageStatistics
. - Added the method
getMessageStatistics
. - Added the method
getMessagePublicForwards
, returning all forwards of a message to public channels. - Removed the now superfluous field
views
from the classmessage
. - Removed the now superfluous update
updateMessageViews
.
- Added the class
- Improved support for native polls:
- Added the field
explanation
to the classpollTypeQuiz
. - Added the fields
close_date
andopen_period
to the classpoll
. - Added the fields
close_date
andopen_period
to the classinputMessagePoll
; for bots only. - Increased maximum poll question length to 300 characters for bots.
- Added the field
- Added support for anonymous administrators in supergroups:
- Added the field
is_anonymous
to the classeschatMemberStatusCreator
andchatMemberStatusAdministrator
. - The field
author_signature
in the classmessage
can now contain a custom title of the anonymous administrator that sent the message.
- Added the field
- Added support for a new type of inline keyboard buttons, requiring user password entry:
- Added the class
inlineKeyboardButtonTypeCallbackWithPassword
, representing a button requiring password entry from a user. - Added the class
callbackQueryPayloadDataWithPassword
, representing new type of callback button payload, which must be used for the buttons of the typeinlineKeyboardButtonTypeCallbackWithPassword
.
- Added the class
- Added support for making the location of the user public:
- Added the writable option "is_location_visible" to allow other users see location of the current user.
- Added the method
setLocation
, which should be called ifgetOption("is_location_visible")
is true and location changes by more than 1 kilometer.
- Improved Notification API:
- Added the field
sender_name
to the classnotificationTypeNewPushMessage
. - Added the writable option "disable_sent_scheduled_message_notifications" for disabling notifications about outgoing scheduled messages that were sent.
- Added the field
is_outgoing
to the classnotificationTypeNewPushMessage
for recognizing outgoing scheduled messages that were sent. - Added the fields
has_audios
andhas_documents
to the classpushMessageContentMediaAlbum
.
- Added the field
- Added the field
date
to the classdraftMessage
. - Added the update
updateStickerSet
, which is sent after a sticker set is changed. - Added support for pagination in trending sticker sets:
- Added the parameters
offset
andlimit
to the methodgetTrendingStickerSets
. - Changed the field
sticker_sets
in the updateupdateTrendingStickerSets
to contain only the prefix of trending sticker sets.
- Added the parameters
- Messages that failed to send can now be found using the filter
searchMessagesFilterFailedToSend
. - Added the ability to disable automatic server-side file type detection using the new field
disable_content_type_detection
of the classinputMessageDocument
. - Improved chat action bar:
- Added the field
can_unarchive
to the classeschatActionBarReportSpam
andchatActionBarReportAddBlock
, which is true whenever the chat was automatically archived. - Added the field
distance
to the classchatActionBarReportAddBlock
, which denotes the distance between the users.
- Added the field
- Added support for actions suggested to the user by the server:
- Added the class
SuggestedAction
, representing possible actions suggested by the server. - Added the update
updateSuggestedActions
. - Added the method
hideSuggestedAction
, which can be used to dismiss a suggested action.
- Added the class
- Supported attaching stickers to animations:
- Added the field
has_stickers
to the classanimation
. - Added the field
added_sticker_file_ids
to the classinputMessageAnimation
.
- Added the field
- Added methods for phone number formatting:
- Added the class
countryInfo
, describing a country. - Added the class
countries
, containing a list of countries. - Added the method
getCountries
, returning a list of all existing countries. - Added the class
phonenumberinfo
and the methodgetPhoneNumberInfo
, which can be used to format a phone number according to local rules.
- Added the class
- Improved location support:
- Added the field
horizontal_accuracy
to the classlocation
. - Added the field
heading
to the classesmessageLocation
andinputMessageLocation
for live locations. - Added the parameter
heading
to the methodseditMessageLiveLocation
andeditInlineMessageLiveLocation
.
- Added the field
- Added support for proximity alerts in live locations:
- Added the field
proximity_alert_radius
to the classesmessageLocation
andinputMessageLocation
. - Added the parameter
proximity_alert_radius
to the methodseditMessageLiveLocation
andeditInlineMessageLiveLocation
. - Added the new message content
messageProximityAlertTriggered
, received whenever a proximity alert is triggered.
- Added the field
- Added
CentOS 7
andCentOS 8
operating systems to the TDLib build instructions generator. - Added the CMake configuration option TD_ENABLE_MULTI_PROCESSOR_COMPILATION, which can be used to enable parallel build with MSVC.
- Added support for sending and receiving messages in secret chats with silent notifications.
- Added the field
progressive_sizes
to the classphoto
to allow partial progressive JPEG photo download. - Added the field
redirect_stderr
to the classlogStreamFile
to allow explicit control over stderr redirection to the log file. - Added the read-only option "can_archive_and_mute_new_chats_from_unknown_users", which can be used to check, whether the option "archive_and_mute_new_chats_from_unknown_users" can be changed.
- Added the writable option "archive_and_mute_new_chats_from_unknown_users", which can be used to automatically archive and mute new chats from non-contacts. The option can be set only if the option "can_archive_and_mute_new_chats_from_unknown_users" is true.
- Added the writable option "message_unload_delay", which can be used to change the minimum delay before messages are unloaded from the memory.
- Added the writable option "disable_persistent_network_statistics", which can be used to disable persistent network usage statistics, significantly reducing disk usage.
- Added the writable option "disable_time_adjustment_protection", which can be used to disable protection from external time adjustment, significantly reducing disk usage.
- Added the writable option "ignore_default_disable_notification" to allow the application to manually specify the
disable_notification
option each time when sending messages instead of following the default per-chat settings. - Added the read-only option "telegram_service_notifications_chat_id", containing the identifier of the Telegram service notifications chat.
- Added the read-only option "replies_bot_chat_id", containing the identifier of the @replies bot.
- Added the read-only option "group_anonymous_bot_user_id", containing the identifier of the bot which is shown as the sender of anonymous group messages when viewed from an outdated client.
- Added the new venue provider value "gplaces" for Google Places.
- Added the parameter
return_deleted_file_statistics
to the methodoptimizeStorage
to return information about the files that were deleted instead of the ones that were not. - Added the ability to search for supergroup members to mention by their name and username:
- Added the new filter
supergroupMembersFilterMention
for the methodgetSupergroupMembers
. - Added the new filter
chatMembersFilterMention
for the methodsearchChatMembers
.
- Added the new filter
- Added support for highlighting bank card numbers:
- Added the new text entity
textEntityTypeBankCardNumber
. - Added the classes
bankCardInfo
andbankCardActionOpenUrl
, containing information about a bank card. - Added the method
getBankCardInfo
, returning information about a bank card.
- Added the new text entity
- Improved methods for managing sticker sets by bots:
- Added the method
setStickerSetThumbnail
. - Added the ability to create new animated sticker sets and add new stickers to them by adding
the class
inputStickerAnimated
. - Renamed the class
inputSticker
toinputStickerStatic
. - Renamed the field
png_sticker
tosticker
in the classinputStickerStatic
.
- Added the method
- Added the method
setCommands
for bots. - Added the method
getCallbackQueryMessage
for bots. - Added support for starting bots in private chats through
sendBotStartMessage
. - Added the field
total_count
to the classchats
. The field should have a precise value for the responses of the methodsgetChats
,searchChats
andgetGroupsInCommon
. - Added the update
updateAnimationSearchParameters
, containing information about animation search parameters. - Documented that
getRepliedMessage
can be used to get a pinned message, a game message, or an invoice message for messages of the typesmessagePinMessage
,messageGameScore
, andmessagePaymentSuccessful
respectively. - Added guarantees that the field
member_count
in the classsupergroup
is known if the supergroup was received from the methodssearchChatsNearby
,getInactiveSupergroupChats
,getSuitableDiscussionChats
,getGroupsInCommon
, orgetUserPrivacySettingRules
. - Updated SQLCipher to 4.4.0.
- Updated dependencies in the prebuilt TDLib for Android:
- Updated SDK to SDK 30.
- Updated NDK to r21d, which dropped support for 32-bit ARM devices without Neon support.
- Updated recommended
emsdk
version fortdweb
building to the 2.0.6. - Removed the ability to change the update handler after client creation in native .NET binding, Java example and prebuilt library for Android.
- Removed the ability to change the default exception handler after client creation in Java example and prebuilt library for Android.
- Removed the ability to close Client using close() method in Java example and prebuilt library for Android. Use the method TdApi.close() instead.
- Changed license of source code in prebuilt library for Android to Boost Software License, Version 1.0.
Changes in 1.6.0 (31 Jan 2020):
- Added support for multiple chat lists. Currently, only two chat lists Main and Archive are supported:
- Added the class
ChatList
, which represents a chat list and could bechatListMain
orchatListArchive
. - Added the field
chat_list
to the classchat
, denoting the chat list to which the chat belongs. - Added the parameter
chat_list
to the methodsgetChats
,searchMessages
andsetPinnedChats
. - Added the field
chat_list
to the updatesupdateUnreadMessageCount
andupdateUnreadChatCount
. - Added the field
total_count
to the updateupdateUnreadChatCount
, containing the total number of chats in the list. - Added the update
updateChatChatList
, which is sent after a chat is moved to or from a chat list. - Added the method
setChatChatList
, which can be used to move a chat between chat lists. - Added the option
pinned_archived_chat_count_max
for the maximum number of pinned chats in the Archive chat list.
- Added the class
- Added support for scheduled messages:
- Added the classes
messageSchedulingStateSendAtDate
andmessageSchedulingStateSendWhenOnline
, representing the scheduling state of a message. - Added the field
scheduling_state
to the classmessage
, which allows to distinguish between scheduled and ordinary messages. - The update
updateNewMessage
can now contain a scheduled message and must be handled appropriately. - The updates
updateMessageContent
,updateDeleteMessages
,updateMessageViews
,updateMessageSendSucceeded
,updateMessageSendFailed
, andupdateMessageSendAcknowledged
can now contain identifiers of scheduled messages. - Added the class
sendMessageOptions
, which contains options for sending messages, including the scheduling state of the messages. - Replaced the parameters
disable_notification
andfrom_background
in the methodssendMessage
,sendMessageAlbum
,sendInlineQueryResultMessage
, andforwardMessages
with the new fieldoptions
of the typesendMessageOptions
. - Added the method
editMessageSchedulingState
, which can be used to reschedule a message or send it immediately. - Added the method
getChatScheduledMessages
, which returns all scheduled messages in a chat. - Added the field
has_scheduled_messages
to the classchat
. - Added the update
updateChatHasScheduledMessages
, which is sent whenever the fieldhas_scheduled_messages
changes in a chat. - Added support for reminders in Saved Messages and notifications about other sent scheduled messages in the Notification API.
- Added the classes
- Added support for adding users without a known phone number to the list of contacts:
- Added the method
addContact
for adding or renaming contacts without a known phone number. - Added the field
need_phone_number_privacy_exception
to the classuserFullInfo
, containing the default value for the second parameter of the methodaddContact
. - Added the fields
is_contact
andis_mutual_contact
to the classuser
. - Removed the class
LinkState
and the fieldsoutgoing_link
andincoming_link
from the classuser
.
- Added the method
- Improved support for the top chat action bar:
- Added the class
ChatActionBar
, representing all possible types of the action bar. - Added the field
action_bar
to the classchat
. - Removed the legacy class
chatReportSpamState
. - Removed the legacy methods
getChatReportSpamState
andchangeChatReportSpamState
. - Added the update
updateChatActionBar
. - Added the method
removeChatActionBar
, which allows to dismiss the action bar. - Added the method
sharePhoneNumber
, allowing to share the phone number of the current user with a mutual contact. - Added the new reason
chatReportReasonUnrelatedLocation
for reporting location-based groups unrelated to their stated location.
- Added the class
- Improved support for text entities:
- Added the new types of text entities
textEntityTypeUnderline
andtextEntityTypeStrikethrough
. - Added support for nested entities. Entities can be nested, but must not mutually intersect with each other. Pre, Code and PreCode entities can't contain other entities. Bold, Italic, Underline and Strikethrough entities can contain and be contained in all other entities. All other entities can't contain each other.
- Added the field
version
to the methodtextParseModeMarkdown
. Versions 0 and 1 correspond to Bot API Markdown parse mode, version 2 to Bot API MarkdownV2 parse mode with underline, strikethrough and nested entities support. - The new entity types and nested entities are supported in secret chats also if its layer is at least 101.
- Added the new types of text entities
- Added support for native non-anonymous, multiple answer, and quiz-style polls:
- Added support for quiz-style polls, which has exactly one correct answer option and can be answered only once.
- Added support for regular polls, which allows multiple answers.
- Added the classes
pollTypeRegular
andpollTypeQuiz
, representing the possible types of a poll. - Added the field
type
to the classespoll
andinputMessagePoll
. - Added support for non-anonymous polls with visible votes by adding the field
is_anonymous
to the classespoll
andinputMessagePoll
. - Added the method
getPollVoters
returning users that voted for the specified option in a non-anonymous poll. - Added the new reply markup keyboard button
keyboardButtonTypeRequestPoll
. - Added the field
is_regular
to the classpushMessageContentPoll
. - Added the update
updatePollAnswer
for bots only. - Added the field
is_closed
to the classinputMessagePoll
, which can be used by bots to send a closed poll.
- Clarified in the documentation that file remote ID is guaranteed to be usable only if the corresponding file is still accessible to the user and is known to TDLib. For example, if the file is from a message, then the message must be not deleted and accessible to the user. If the file database is disabled, then the corresponding object with the file must be preloaded by the client.
- Added support for administrator custom titles:
- Added the field
custom_title
tochatMemberStatusCreator
andchatMemberStatusAdministrator
classes. - Added the classes
chatAdministrator
andchatAdministrators
, containing user identifiers along with their custom administrator title and owner status. - Replaced the result type of the method
getChatAdministrators
withchatAdministrators
.
- Added the field
- Improved Instant View support:
- Added the new web page block
pageBlockVoiceNote
. - Changed value of invisible cells in
pageBlockTableCell
to null. - Added the field
is_cached
to the classrichTextUrl
.
- Added the new web page block
- Improved support for chat backgrounds:
- Added the classes
backgroundFillSolid
for solid color backgrounds andbackgroundFillGradient
for gradient backgrounds. - Added support for TGV (gzipped subset of SVG with MIME type "application/x-tgwallpattern") background patterns in addition to PNG patterns. Background pattern thumbnails are still always in PNG format.
- Replaced the field
color
in the classbackgroundTypePattern
with the fieldfill
of typeBackgroundFill
. - Replaced the class
backgroundTypeSolid
with the classbackgroundTypeFill
.
- Added the classes
- Added support for discussion groups for channel chats:
- Added the field
linked_chat_id
to the classsupergroupFullInfo
containing the identifier of a discussion supergroup for the channel, or a channel, for which the supergroup is the designated discussion supergroup. - Added the field
has_linked_chat
to the classsupergroup
. - Added the method
getSuitableDiscussionChats
, which returns a list of chats which can be assigned as a discussion group for a channel by the current user. - Added the method
setChatDiscussionGroup
, which can be used to add or remove a discussion group from a channel. - Added the class
chatEventLinkedChatChanged
representing a change of the linked chat in the chat event log.
- Added the field
- Added support for slow mode in supergroups:
- Added the field
is_slow_mode_enabled
to the classsupergroup
. - Added the field
slow_mode_delay
to the classsupergroupFullInfo
. - Added the method
setChatSlowModeDelay
, which can be used to change the slow mode delay setting in a supergroup. - Added the class
chatEventSlowModeDelayChanged
representing a change of the slow mode delay setting in the chat event log.
- Added the field
- Improved privacy settings support:
- Added the classes
userPrivacySettingRuleAllowChatMembers
anduserPrivacySettingRuleRestrictChatMembers
to include or exclude all group members in a privacy setting rule. - Added the class
userPrivacySettingShowPhoneNumber
for managing the visibility of the user's phone number. - Added the class
userPrivacySettingAllowFindingByPhoneNumber
for managing whether the user can be found by their phone number.
- Added the classes
- Added the method
checkCreatedPublicChatsLimit
for checking whether the maximum number of owned public chats has been reached. - Added support for transferring ownership of supergroup and channel chats:
- Added the method
transferChatOwnership
. - Added the class
CanTransferOwnershipResult
and the methodcanTransferOwnership
for checking whether chat ownership can be transferred from the current session.
- Added the method
- Added support for location-based supergroups:
- Added the class
chatLocation
, which contains the location to which the supergroup is connected. - Added the field
has_location
to the classsupergroup
. - Added the field
location
to the classsupergroupFullInfo
. - Added the ability to create location-based supergroups via the new field
location
in the methodcreateNewSupergroupChat
. - Added the method
setChatLocation
, which allows to change location of location-based supergroups. - Added the field
can_set_location
to the classsupergroupFullInfo
. - Added the class
PublicChatType
, which can be one ofpublicChatTypeHasUsername
orpublicChatTypeIsLocationBased
. - Added the parameter
type
to the methodgetCreatedPublicChats
, which allows to get location-based supergroups owned by the user. - Supported location-based supergroups as public chats where appropriate.
- Added the class
chatEventLocationChanged
representing a change of the location of a chat in the chat event log.
- Added the class
- Added support for searching chats and users nearby:
- Added the classes
chatNearby
andchatsNearby
, containing information about chats along with the distance to them. - Added the method
searchChatsNearby
, which returns chats and users nearby. - Added the update
updateUsersNearby
, which is sent 60 seconds after a successfulsearchChatsNearby
request.
- Added the classes
- Improved support for inline keyboard buttons of the type
inlineKeyboardButtonTypeLoginUrl
:- Added the class
LoginUrlInfo
and the methodgetLoginUrlInfo
, which allows to get information about an inline button of the typeinlineKeyboardButtonTypeLoginUrl
. - Added the method
getLoginUrl
for automatic authorization on the target website.
- Added the class
- Improved support for content restrictions:
- The field
restriction_reason
in the classesuser
andchannel
now contains only a human-readable description why access must be restricted. It is non-empty if and only if access to the chat needs to be restricted. - Added the field
restriction_reason
to the classmessage
. It is non-empty if and only if access to the message needs to be restricted. - Added the writable option
ignore_platform_restrictions
, which can be set in non-store apps to ignore restrictions specific to the currently used operating system. - Added the writable option
ignore_sensitive_content_restrictions
, which can be set to show sensitive content on all user devices.getOption("ignore_sensitive_content_restrictions")
can be used to fetch the actual value of the option, the option will not be immediately updated after a change from another device. - Added the read-only option
can_ignore_sensitive_content_restrictions
, which can be used to check, whether the optionignore_sensitive_content_restrictions
can be changed.
- The field
- Added support for QR code authentication for already registered users:
- Added the authorization state
authorizationStateWaitOtherDeviceConfirmation
. - Added the method
requestQrCodeAuthentication
, which can be used in theauthorizationStateWaitPhoneNumber
state instead of the methodsetAuthenticationPhoneNumber
to request QR code authentication. - Added the method
confirmQrCodeAuthentication
for authentication confirmation from another device.
- Added the authorization state
- Added the update
updateMessageLiveLocationViewed
, which is supposed to trigger an edit of the corresponding live location. - Added the parameter
input_language_code
to the methodsearchEmojis
. - Added the method
getInactiveSupergroupChats
, to be used when the user receives a CHANNELS_TOO_MUCH error after reaching the limit on the number of joined supergroup and channel chats. - Added the field
unique_id
to the classremoteFile
, which can be used to identify the same file for different users. - Added the new category of top chat list
topChatCategoryForwardChats
. - Added the read-only option
animated_emoji_sticker_set_name
, containing name of a sticker set with animated emojis. - Added the read-only option
unix_time
, containing an estimation of the current Unix timestamp. The option will not be updated automatically unless the difference between the previous estimation and the locally available monotonic clocks changes significantly. - Added the field
is_silent
to the classnotification
, so silent notifications can be shown with the appropriate mark. - Added the field
video_upload_bitrate
to the classautoDownloadSettings
. - Disallowed to call
setChatNotificationSettings
method on the chat with self, which never worked. - Added support for
ton://
URLs in messages and inline keyboard buttons.
Changes in 1.5.0 (9 Sep 2019):
- Changed authorization workflow:
- Added the state
authorizationStateWaitRegistration
, which will be received afterauthorizationStateWaitCode
for users who are not registered yet. - Added the method
registerUser
, which must be used in theauthorizationStateWaitRegistration
state to finish registration of the user. - Removed the fields
is_registered
andterms_of_service
from the classauthorizationStateWaitCode
. - Removed the parameters
first_name
andlast_name
from the methodcheckAuthenticationCode
.
- Added the state
- Added support for messages with an unknown sender (zero
sender_user_id
) in private chats, basic groups and supergroups. Currently, the sender is unknown for posts in channels and for channel posts automatically forwarded to the discussion group. - Added support for the new permission system for non-administrator users in groups:
- Added the class
chatPermissions
containing all supported permissions, including new permissionscan_send_polls
,can_change_info
,can_invite_users
andcan_pin_messages
. - Added the field
permissions
to the classchat
, describing actions that non-administrator chat members are allowed to take in the chat. - Added the update
updateChatPermissions
. - Added the method
setChatPermissions
for changing chat permissions. - Added the class
chatEventPermissionsChanged
representing a change of chat permissions in the chat event log. - Replaced the fields
can_send_messages
,can_send_media_messages
,can_send_other_messages
,can_add_web_page_previews
in the classchatMemberStatusRestricted
with the fieldpermissions
of the typechatPermissions
. - Removed the field
everyone_is_administrator
from thebasicGroup
class in favor of the fieldpermissions
of the classchat
. - Removed the field
anyone_can_invite
from thesupergroup
class in favor of the fieldpermissions
of the classchat
. - Removed the method
toggleBasicGroupAdministrators
in favor ofsetChatPermissions
. - Removed the method
toggleSupergroupInvites
in favor ofsetChatPermissions
. - Renamed the field
anyone_can_invite
tocan_invite_users
in the classchatEventInvitesToggled
. - The permissions
can_send_other_messages
andcan_add_web_page_previews
now imply onlycan_send_messages
instead ofcan_send_media_messages
. - Allowed administrators in basic groups to use the method
generateChatInviteLink
.
- Added the class
- Added out of the box
OpenBSD
andNetBSD
operating systems support. - Added possibility to use
LibreSSL
>= 2.7.0 instead ofOpenSSL
to build TDLib. - Added instructions for building TDLib on
Debian 10
,OpenBSD
andNetBSD
to the TDLib build instructions generator. - Added support for Backgrounds 2.0:
- Added the classes
BackgroundType
,background
,backgrounds
andInputBackground
. - Added the method
getBackground
returning the list of backgrounds installed by the user. - Added the method
setBackground
for changing the background selected by the user. - Added the update
updateSelectedBackground
, which is sent right after a successful initialization and whenever the selected background changes. - Added the method
removeBackground
for removing a background from the list of installed backgrounds. - Added the method
resetBackgrounds
for restoring the default list of installed backgrounds. - Added the method
searchBackground
returning a background by its name. - Added the method
getBackgroundUrl
returning a persistent URL for a background. - Removed the
getWallpapers
method. - Removed the
wallpaper
and thewallpapers
classes. - The class
fileTypeWallpaper
can be used for remote file identifiers of both old wallpapers and new backgrounds.
- Added the classes
- Added support for descriptions in basic groups:
- Added the field
description
to the classbasicGroupFullInfo
. - Replaced the method
setSupergroupDescription
withsetChatDescription
which can be used for any chat type.
- Added the field
- Added support for emoji suggestions:
- Added the method
searchEmojis
for searching emojis by keywords. - Added the method
getEmojiSuggestionsUrl
, which can be used to automatically log in to the translation platform and suggest new emoji replacements. - Renamed the class
stickerEmojis
toemojis
.
- Added the method
- Changed type of the fields
old_photo
andnew_photo
in the classchatEventPhotoChanged
fromchatPhoto
tophoto
. - Changed recommended size for
inputThumbnail
from 90x90 to 320x320. - Combined all supported settings for phone number authentication:
- Added the class
phoneNumberAuthenticationSettings
which contains all the settings. - Replaced the parameters
is_current_phone_number
andallow_flash_call
in the methodssetAuthenticationPhoneNumber
,sendPhoneNumberConfirmationCode
,sendPhoneNumberVerificationCode
andchangePhoneNumber
with the parametersettings
of the typephoneNumberAuthenticationSettings
. - Added support for automatic SMS code verification for official applications via the new field
allow_app_hash
in the classphoneNumberAuthenticationSettings
.
- Added the class
- Added support for auto-download settings presets.
- Added the classes
autoDownloadSettings
andautoDownloadSettingsPresets
. - Added the method
getAutoDownloadSettingsPresets
for getting the settings. - Added the method
setAutoDownloadSettings
, which needs to be called whenever the user changes the settings.
- Added the classes
- Added support for minithumbnails - thumbnail images of a very poor quality and low resolution:
- Added the class
minithumbnail
. - Added the field
minithumbnail
toanimation
,document
,photo
,video
andvideoNote
classes. - Added the field
audio_cover_minithumbnail
to the classaudio
.
- Added the class
- Added support for resending messages which failed to send:
- Added the fields
error_code
,error_message
,can_retry
andretry_after
to the classmessageSendingStateFailed
. - Added the method
resendMessages
.
- Added the fields
- Added the field
is_animated
to thesticker
,stickerSet
andstickerSetInfo
classes. Animated stickers can be received anywhere where non-animated stickers can appear. - Added the parameters
send_copy
andremove_caption
to theforwardMessages
method to allow forwarding of messages without links to the originals. - Added the fields
send_copy
andremove_caption
toinputMessageForwarded
method to allow forwarding of a message without link to the original message. - Added the method
getMessageLinkInfo
for getting information about a link to a message in a chat. - Added the class
userPrivacySettingShowProfilePhoto
for managing visibility of the user's profile photo. - Added the class
userPrivacySettingShowLinkInForwardedMessages
for managing whether a link to the user's account is included with forwarded messages. - Added the field
thumbnail
to the classesstickerSet
andstickerSetInfo
, containing a thumbnail for the sticker set. - Added the field
is_scam
to the classesuser
andsupergroup
. - Added a new kind of inline keyboard button
inlineKeyboardButtonTypeLoginUrl
, which for the moment must be processed in the same way as aninlineKeyboardButtonTypeUrl
. - Added the new class
supergroupMembersFilterContacts
, allowing to only search for contacts ingetSupergroupMembers
. - Added the new class
chatMembersFilterContacts
, allowing to only search for contacts insearchChatMembers
. - Added the class
chatEventPollStopped
representing the closing of a poll in a message in the chat event log. - Added ability to specify the exact types of problems with a call in the method
sendCallRating
and the new classCallProblem
. - Changes in tdweb:
- Supported non-zero
offset
andlimit
inreadFilePart
.
- Supported non-zero
Changes in 1.4.0 (1 May 2019):
- Added a TDLib build instructions generator, covering in details TDLib building on the most popular operating systems.
- Added an example of TDLib building and usage from a browser. See https://github.com/tdlib/td/blob/master/example/web/ for more details.
- Allowed to pass NULL pointer to
td_json_client_execute
instead of a previously created JSON client. Now you can use synchronous TDLib methods through a JSON interface before creating a TDLib JSON client. - Added support for media streaming by allowing to download any part of a file:
- Added the
offset
parameter todownloadFile
which specifies the starting position from which the file should be downloaded. - Added the
limit
parameter todownloadFile
which specifies how many bytes should be downloaded starting from theoffset
position. - Added the field
download_offset
to the classlocalFile
which contains the current download offset. - The field
downloaded_prefix_size
of thelocalFile
class now contains the number of available bytes from the positiondownload_offset
instead of from the beginning of the file. - Added the method
getFileDownloadedPrefixSize
which can be used to get the number of locally available file bytes from a given offset without actually changing the download offset.
- Added the
- Added the parameter
synchronous
todownloadFile
which causes the request to return the result only after the download is completed. - Added support for native polls in messages:
- Added
messagePoll
to the types of message content; contains a poll. - Added the classes
poll
andpollOption
describing a poll and a poll answer option respectively. - Added
inputMessagePoll
to the types of new input message content; can be used to send a poll. - Added the method
setPollAnswer
which can be used for voting in polls. - Added the method
stopPoll
which can be used to stop polls. Use theMessage.can_be_edited
field to check whether this method can be called on a message. - Added the update
updatePoll
for bots only. Ordinary users receive poll updates throughupdateMessageContent
.
- Added
- Added a Notification API. See article https://core.telegram.org/tdlib/notification-api for a detailed description.
- Added the class
pushReceiverId
which contains a globally unique identifier of the push notification subscription. - Changed the return type of the method
registerDevice
topushReceiverId
to allow matching of push notifications with TDLib instances. - Removed the fields
disable_notification
andcontains_mention
fromupdateNewMessage
. - Renamed the class
deviceTokenGoogleCloudMessaging
todeviceTokenFirebaseCloudMessaging
. - Added the field
encrypt
to classesdeviceTokenApplePushVoIP
anddeviceTokenFirebaseCloudMessaging
which allows to subscribe for end-to-end encrypted push notifications. - Added the option
notification_group_count_max
which can be used to enable the Notification API and set the maximum number of notification groups to be shown simultaneously. - Added the option
notification_group_size_max
which can be used to set the maximum number of simultaneously shown notifications in a group. - Added the synchronous method
getPushReceiverId
for matching a push notification with a TDLib instance. - Added the method
processPushNotification
for handling of push notifications. - Removed the method
processDcUpdate
in favor of the generalprocessPushNotification
method. - Added the update
updateNotificationGroup
, sent whenever a notification group changes. - Added the update
updateNotification
, sent whenever a notification changes. - Added the update
updateActiveNotifications
for syncing the list of active notifications on startup. - Added the update
updateHavePendingNotifications
which can be used to improve lifetime handling of the TDLib instance. - Added the possibility to disable special handling of notifications about pinned messages via the new settings
use_default_disable_pinned_message_notifications
,disable_pinned_message_notifications
in the classchatNotificationSettings
and the new settingdisable_pinned_message_notifications
in the classscopeNotificationSettings
. - Added the possibility to disable special handling of notifications about mentions and replies via the new settings
use_default_disable_mention_notifications
,disable_mention_notifications
in the classchatNotificationSettings
and the new settingdisable_mention_notifications
in the classscopeNotificationSettings
. - Added the class
PushMessageContent
describing the content of a notification, received through a push notification. - Added the class
NotificationType
describing a type of a notification. - Added the class
notification
containing information about a notification. - Added the class
NotificationGroupType
describing a type of a notification group. - Added the class
notificationGroup
describing a state of a notification group. - Added the methods
removeNotification
andremoveNotificationGroup
for handling notifications removal by the user. - Added the separate notification scope
notificationSettingsScopeChannelChats
for channel chats.
- Added the class
- Added support for pinned notifications in basic groups and Saved Messages:
- Added the field
pinned_message_id
to the classchat
. - Removed the field
pinned_message_id
from the classsupergroupFullInfo
in favor ofchat.pinned_message_id
. - Added the update
updateChatPinnedMessage
. - The right
can_pin_messages
is now applicable to both basic groups and supergroups. - Replaced the method
pinSupergroupMessage
withpinChatMessage
which can be used for any chat type. - Replaced the method
unpinSupergroupMessage
withunpinChatMessage
which can be used for any chat type.
- Added the field
- Added new synchronous methods for managing TDLib internal logging. The old functions are deprecated and
will be removed in TDLib 2.0.0.
- Added the synchronous method
setLogStream
for changing the stream to which the TDLib internal log is written. - Added the synchronous method
getLogStream
for getting information about the currently used log stream. - Added the classes
logStreamDefault
,logStreamFile
andlogStreamEmpty
describing different supported kinds of log streams. - Added the class
logVerbosityLevel
containing the verbosity level of the TDLib internal log. - Added the class
logTags
containing a list of available TDLib internal log tags. - Added the synchronous method
setLogVerbosityLevel
for changing verbosity level of logging. - Added the synchronous method
getLogVerbosityLevel
for getting the current verbosity level of logging. - Added the synchronous method
getLogTags
returning all currently supported log tags. - Added the synchronous method
setLogTagVerbosityLevel
for changing the verbosity level of logging for some specific part of the code. - Added the synchronous method
getLogTagVerbosityLevel
for getting the current verbosity level for a specific part of the code. - Added the synchronous method
addLogMessage
for using the TDLib internal log by the application.
- Added the synchronous method
- Added support for Instant View 2.0:
- Replaced the field
has_instant_view
in classwebPage
with theinstant_view_version
field. - Added the field
version
to the classwebPageInstantView
. - Added the class
pageBlockCaption
. - Changed the type of
caption
fields inpageBlockAnimation
,pageBlockAudio
,pageBlockPhoto
,pageBlockVideo
,pageBlockEmbedded
,pageBlockEmbeddedPost
,pageBlockCollage
andpageBlockSlideshow
fromRichText
topageBlockCaption
. - Added the class
pageBlockListItem
and replaced the content of thepageBlockList
class with a list ofpageBlockListItem
. - Added 6 new kinds of
RichText
:richTextSubscript
,richTextSuperscript
,richTextMarked
,richTextPhoneNumber
,richTextIcon
andrichTextAnchor
. - Added new classes
pageBlockRelatedArticle
,PageBlockHorizontalAlignment
,PageBlockVerticalAlignment
andpageBlockTableCell
. - Added new block types
pageBlockKicker
,pageBlockRelatedArticles
,pageBlockTable
,pageBlockDetails
andpageBlockMap
. - Added the flag
is_rtl
to the classwebPageInstantView
. - Renamed the field
caption
in classespageBlockBlockQuote
andpageBlockPullQuote
tocredit
. - Dimensions in
pageBlockEmbedded
can now be unknown. - Added the field
url
topageBlockPhoto
which contains a URL that needs to be opened when the photo is clicked. - Added the field
url
towebPageInstantView
which must be used for the correct handling of anchors.
- Replaced the field
- Added methods for confirmation of the 2-step verification recovery email address:
- Added the method
checkRecoveryEmailAddressCode
for checking the verification code. - Added the method
resendRecoveryEmailAddressCode
for resending the verification code. - Replaced the field
unconfirmed_recovery_email_address_pattern
in the classpasswordState
with therecovery_email_address_code_info
field containing full information about the code. - The necessity of recovery email address confirmation in
setPassword
andsetRecoveryEmailAddress
methods is now returned by the correspondingpasswordState
and not by the errorEMAIL_UNCONFIRMED
.
- Added the method
- Improved the
MessageForwardInfo
class and added support for hidden original senders:- Removed the old
messageForwardedPost
andmessageForwardedFromUser
classes. - Added the class
messageForwardInfo
which contains information about the origin of the message, original sending date and identifies the place from which the message was forwarded the last time for messages forwarded to Saved Messages. - Added the classes
messageForwardOriginUser
,messageForwardOriginHiddenUser
andmessageForwardOriginChannel
which describe the exact origins of a message.
- Removed the old
- Improved getting the list of user profile photos:
- Added the class
userProfilePhoto
, containingid
,added_date
andsizes
of a profile photo. - Changed the type of the field
photos
inuserProfilePhotos
to a list ofuserProfilePhoto
instead of a list ofphoto
.getUserProfilePhotos
now returns a date for each profile photo. - Removed the field
id
from the classphoto
(this field was only needed in the result ofgetUserProfilePhotos
).
- Added the class
- Added the possibility to get a Telegram Passport authorization form before asking the user for a password:
- Removed the parameter
password
from the methodgetPassportAuthorizationForm
. - Moved the fields
elements
anderrors
from the classpassportAuthorizationForm
to the new classpassportElementsWithErrors
. - Added the method
getPassportAuthorizationFormAvailableElements
that takes the user's password and returns previously uploaded Telegram Passport elements and errors in them.
- Removed the parameter
- Added the field
file_index
to the classespassportElementErrorSourceFile
andpassportElementErrorSourceTranslationFile
. - Added the method
getCurrentState
returning all updates describing the currentTDLib
state. It can be used to restore the correct state after connecting to a running TDLib instance. - Added the class
updates
which contains a list of updates and is returned by thegetCurrentState
method. - Added the update
updateChatOnlineMemberCount
which is automatically sent for open group chats if the number of online members in a group changes. - Added support for custom language packs downloaded from the server:
- Added the fields
base_language_pack_id`` to the class
languagePackInfo`. Strings from the base language pack must be used for untranslated keys from the chosen language pack. - Added the fields
plural_code
,is_official
,is_rtl
,is_beta
,is_installed
,total_string_count
,translated_string_count
,translation_url
to the classlanguagePackInfo
. - Added the method
addCustomServerLanguagePack
which adds a custom server language pack to the list of installed language packs. - Added the method
getLanguagePackInfo
which can be used for handlinghttps://t.me/setlanguage/...
links. - Added the method
synchronizeLanguagePack
which can be used to fetch the latest versions of all strings from a language pack. The method doesn't need to be called explicitly for the current used/base language packs. - The method
deleteLanguagePack
now also removes the language pack from the list of installed language packs.
- Added the fields
- Added the method
getChatNotificationSettingsExceptions
which can be used to get chats with non-default notification settings. - Added the parameter
hide_via_bot
tosendInlineQueryResultMessage
which can be used forgetOption("animation_search_bot_username")
,getOption("photo_search_bot_username")
andgetOption("venue_search_bot_username")
bots to hide that the message was sent via the bot. - Added the class
chatReportReasonChildAbuse
which can be used to report a chat for child abuse. - Added the method
getMessageLocally
which returns a message only if it is available locally without a network request. - Added the method
writeGeneratedFilePart
which can be used to write a generated file if there is no direct access to TDLib's file system. - Added the method
readFilePart
which can be used to read a file from the TDLib file cache. - Added the class
filePart
to represent the result of the newreadFilePart
method. - Added the field
log_size
to thestorageStatisticsFast
class which contains the size of the TDLib internal log. Previously the size was included into the value of thedatabase_size
field. - Added the field
language_pack_database_size
to thestorageStatisticsFast
class which contains the size of the language pack database. - Added the field
is_support
to the classuser
which can be used to identify Telegram Support accounts. - Added the class
HttpUrl
encapsulating an HTTP URL. - Added the method
getMessageLink
which can be used to create a private link (which works only for members) to a message in a supergroup or channel. - Added support for channel statistics (coming soon):
- Added the field
can_view_statistics
to thesupergroupFullInfo
class. - Added the method
getChatStatisticsUrl
which returns a URL with the chat statistics.
- Added the field
- Added support for server-side peer-to-peer calls privacy:
- Added the class
userPrivacySettingAllowPeerToPeerCalls
for managing privacy. - Added the field
allow_p2p
tocallStateReady
class which must be used to determine whether a peer-to-peer connection can be used.
- Added the class
- Added the option
ignore_background_updates
which allows to skip all updates received while the TDLib instance was not running. The option does nothing if the database or secret chats are used. - Added the read-only option
expect_blocking
, suggesting whether Telegram is blocked for the user. - Added the read-only option
enabled_proxy_id
, containing the ID of the enabled proxy. - Added the ability to identify password pending sessions (where the code was entered but not
the two-step verification password) via the flag
is_password_pending
in thesession
class. TDLib guarantees that the sessions will be returned by thegetActiveSessions
method in the correct order. - Added the classes
JsonValue
andjsonObjectMember
which represent a JSON value and a member of a JSON object respectively as TDLib API objects. - Added the synchronous methods
getJsonValue
andgetJsonString
for simple conversion between a JSON-encoded string andJsonValue
TDLib API class. - Added the methods
getApplicationConfig
andsaveApplicationLogEvent
to be used for testing purposes. - Added the temporarily class
databaseStatistics
and the methodgetDatabaseStatistics
for rough estimations of database tables size in a human-readable format. - Made the method
Client.Execute
static in .NET interface. - Removed the
on_closed
callback virtual method from low-level C++ ClientActor interface. Callback destructor can be used instead. - Updated dependencies in the prebuilt TDLib for Android:
- Updated SDK to SDK 28 in which helper classes was moved from
android.support.
toandroidx.
package. - Updated NDK to r19c, which dropped support for Android versions up to 4.0.4, so the minimum supported version is Android 4.1.
- Updated OpenSSL to version 1.1.1.
- Added x86_64 libraries.
- Updated SDK to SDK 28 in which helper classes was moved from
- Added out of the box
FreeBSD
support. - Significantly improved TDLib compilation time and decreased compiler RAM usage:
- In native C++ interface
td_api::object_ptr
is now a simple homebrew const-propagating class instead ofstd::unique_ptr
. - Added the script
SplitSource.php
, which can be used to split some source code files before building the library to reduce maximum RAM usage per file at the expense of increased build time.
- In native C++ interface
- The update
updateOption
with theversion
option is now guaranteed to come before all other updates. It can now be used to dynamically discover available methods. - Added the ability to delete incoming messages in private chats and revoke messages without a time limit:
- Added the parameter
revoke
to the methoddeleteChatHistory
; use it to delete chat history for all chat members. - Added the fields
can_be_deleted_only_for_self
andcan_be_deleted_for_all_users
to the classchat
which can be used to determine for whom the chat can be deleted through thedeleteChatHistory
method. - The fields
Message.can_be_deleted_only_for_self
andMessage.can_be_deleted_for_all_users
can still be used to determine for whom the message can be deleted through thedeleteMessages
method.
- Added the parameter
- Added support for server-generated notifications about newly registered contacts:
- Setting the option
disable_contact_registered_notifications
now affects all user sessions. When the option is enabled, the client will still receivemessageContactRegistered
message in the private chat, but there will be no notification about the message. getOption("disable_contact_registered_notifications")
can be used to fetch the actual value of the option, the option will not be updated automatically after a change from another device.
- Setting the option
- Decreased the maximum allowed first name and last name length to 64, chat title length to 128, matching the new server-side limits.
- Decreased the maximum allowed value of the
forward_limit
parameter of theaddChatMember
method from 300 to 100, matching the new server-side limit. - Added protection from opening two TDLib instances with the same database directory from one process.
- Added copying of notification settings of new secret chats from notification settings of the corresponding private chat.
- Excluded the sponsored chat (when using sponsored proxies) from unread counters.
- Allowed to pass decreased local_size in
setFileGenerationProgress
to restart the generation from the beginning. - Added a check for modification time of original file in
inputFileGenerated
whenever possible. If the original file was changed, then TDLib will restart the generation. - Added the destruction of MTProto keys on the server during log out.
- Added support for hexadecimal-encoded and decimal-encoded IPv4 proxy server addresses.
- Improved the behavior of
changeImportedContacts
which now also deletes contacts of users without Telegram accounts from the server. - Added the ability to call
getStorageStatistics
before authorization. - Allowed to pass
limit
= -offset
for negative offset in thegetChatHistory
method. - Changed the recommended
inputThumbnail
size to be at most 320x320 instead of the previous 90x90. - Disabled building by default of the native C interface. Use
cmake --build . --target tdc
to build it. - Numerous optimizations and bug fixes:
- Network implementation for Windows was completely rewritten to allow a literally unlimited number of simultaneously used TDLib instances.
- TDLib instances can now share working threads with each other. Only a limited number of threads will be created even if there are thousands of TDLib instances in a single process.
- Removed the restriction on the size of update or response result in JSON interface.
- Fixed pinning of the 5th chat when there is a sponsored chat.
- Fixed IPv6 on Windows.
- Improved network connections balancing, aliveness checks and overall stability.
- Various autogenerated documentation fixes and improvements.
Changes in 1.3.0 (5 Sep 2018):
- Added a review of existing TDLib based frameworks in different programming languages.
- Added a Getting started guide describing the main TDLib concepts and basic principles required for library usage.
- When a chat is opened, only those messages that have been viewed are marked as read.
- Improved the proxy settings API:
- A list of proxies is stored instead of just one proxy.
- New methods
addProxy
,editProxy
,enableProxy
,disableProxy
,removeProxy
andgetProxies
were added instead ofsetProxy
andgetProxy
. - Added the method
pingProxy
which can be used to compute time needed to receive a response from a Telegram server through a proxy or directly. - Added support for MTProto proxy via class
proxyTypeMtproto
. - Added support for HTTP proxy via class
proxyTypeHttp
. - For each proxy last time it was used is remembered.
- Added the method
getProxyLink
which returns an HTTPS link that can be used to share a proxy with others.
- Improved the notification settings API. Scope notification settings are now properly synchronized between all devices
and chat notification settings can be reset to their default values:
- The
notificationSettings
class was split intochatNotificationSettings
andscopeNotificationSettings
. - Only two notification settings scopes are left:
notificationSettingsScopePrivateChats
which is responsible for default notification settings for private and secret chats andnotificationSettingsScopeGroupChats
for all other chats. updateNotificationSettings
was split intoupdateChatNotificationSettings
andupdateScopeNotificationSettings
.setNotificationSettings
was split intosetChatNotificationSettings
andsetScopeNotificationSettings
.getNotificationSettings
was replaced withgetScopeNotificationSettings
.
- The
- Added the field
filter
to thesearchChatMembers
method to support searching among administrators, bots, restricted and banned members. - Added the ability to use synchronous requests and
setAlarm
before the library is initialized. - Added the ability to send requests that don't need authentication before the library is initialized. These requests
will be postponed and executed at the earliest opportunity. For example,
setNetworkType
can be used to disable the network for TDLib before the library tries to use it;addProxy
can be used to add a proxy before any network activity; orsetOption("use_pfs")
can be used to guarantee that PFS is used for all requests. - Added support for tg:// links in
inlineKeyboardButtonTypeUrl
andtextEntityTypeTextUrl
. - Added the ability to call
deleteAccount
in theauthorizationStateWaitPassword
authorization state. - Added the ability to call
checkAuthenticationCode
with an emptyfirst_name
for unregistered users to check the code validity. - Added the methods
editMessageMedia
andeditInlineMessageMedia
for editing media messages content. - Renamed the class
shippingAddress
toaddress
. - Changed the return value of the
requestPasswordRecovery
method frompasswordRecoveryInfo
toemailAddressAuthenticationCodeInfo
. - Added support for sponsored channels promoted by MTProto-proxies:
- Added the field
is_sponsored
to thechat
class. - Added
updateChatIsSponsored
, sent when this field changes.
- Added the field
- Added support for marking chats as unread:
- Added the field
is_marked_as_unread
tochat
. - Added the update
updateChatIsMarkedAsUnread
. - Added the method
toggleChatIsMarkedAsUnread
.
- Added the field
- Added support for a default value of
disable_notification
, used when a message is sent to the chat:- Added the field
default_disable_notification
tochat
class. - Added the update
updateChatDefaultDisableNotification
. - Added the method
toggleChatDefaultDisableNotification
.
- Added the field
- Added the field
vcard
to thecontact
class. - Added the field
type
tovenue
, which contains a provider-specific type of the venue, - Added the update
updateUnreadChatCount
, enabled when the message database is used and sent when the number of unread chats has changed. - Added the method
addLocalMessage
for adding a local message to a chat. - Added the method
getDeepLinkInfo
, which can return information abouttg://
links that are not supported by the client. - Added support for language packs:
- Added the writable option
language_pack_database_path
which can be used to specify a path to a database for storing language pack strings, so that this database can be shared between different accounts. If not specified, language pack strings will be stored only in memory. Changes to the option are applied only on the next TDLib launch. - Added the writable option
localization_target
for setting up a name for the current localization target (currently supported: "android", "android_x", "ios", "macos" and "tdesktop"). - Added the writable option
language_pack_id
for setting up an identifier of the currently used language pack from the current localization target (a "language pack" represents the collection of strings that can be used to display the interface of a particular application in a particular language). - Added the class
LanguagePackStringValue
describing the possible values of a string from a language pack. - Added the class
languagePackString
describing a string from a language pack. - Added the class
languagePackStrings
containing a list of language pack strings. - Added the class
languagePackInfo
containing information about a language pack from a localization target. - Added the class
localizationTargetInfo
containing information about a localization target. - Added the update
updateLanguagePackStrings
which is sent when some strings in a language pack have changed. - Added the synchronous method
getLanguagePackString
which can be used to get a language pack string from the local database. - Added the method
getLocalizationTargetInfo
which returns information about the current localization target. - Added the method
getLanguagePackStrings
which returns some or all strings from a language pack, possibly fetching them from the server. - Added the method
setCustomLanguagePack
for adding or editing a custom language pack. - Added the method
editCustomLanguagePackInfo
for editing information about a custom language pack. - Added the method
setCustomLanguagePackString
for adding, editing or deleting a string in a custom language pack. - Added the method
deleteLanguagePack
for deleting a language pack from the database. - Added the read-only option
suggested_language_pack_id
containing the identifier of the language pack, suggested for the user by the server.
- Added the writable option
- Added support for Telegram Passport:
- Added two new message contents
messagePassportDataSent
for ordinary users andmessagePassportDataReceived
for bots containing information about Telegram Passport data shared with a bot. - Added the new file type
fileTypeSecure
. - Added the class
datedFile
containing information about a file along with the date it was uploaded. - Added the helper classes
date
,personalDetails
,identityDocument
,inputIdentityDocument
,personalDocument
,inputPersonalDocument
,passportElements
. - Added the class
PassportElementType
describing all supported types of Telegram Passport elements. - Added the class
PassportElement
containing information about a Telegram Passport element. - Added the class
InputPassportElement
containing information about a Telegram Passport element to save. - Added the classes
passportElementError
andPassportElementErrorSource
describing an error in a Telegram Passport element. - Added the field
has_passport_data
to thepasswordState
class. - Added the methods
getPassportElement
,getAllPassportElements
,setPassportElement
,deletePassportElement
for managing Telegram Passport elements. - Added the methods
getPassportAuthorizationForm
andsendPassportAuthorizationForm
used for sharing Telegram Passport data with a service via a bot. - Added the methods
sendPhoneNumberVerificationCode
,resendPhoneNumberVerificationCode
andcheckPhoneNumberVerificationCode
for verification of a phone number used for Telegram Passport. - Added the methods
sendEmailAddressVerificationCode
,resendEmailAddressVerificationCode
andcheckEmailAddressVerificationCode
for verification of an email address used for Telegram Passport. - Added the method
getPreferredCountryLanguage
returning a most popular language in a country. - Added the classes
inputPassportElementError
andInputPassportElementErrorSource
for bots describing an error in a Telegram Passport element. - Added the method
setPassportElementErrors
for bots. - Added the class
encryptedPassportElement
andencryptedCredentials
for bots describing an encrypted Telegram Passport element.
- Added two new message contents
- Improved support for Telegram terms of service:
- Added the class
termsOfService
, containing information about the Telegram terms of service. - Added the field
terms_of_service
toauthorizationStateWaitCode
. - Added the update
updateTermsOfService
coming when new terms of service need to be accepted by the user. - Added the method
acceptTermsOfService
for accepting terms of service. - Removed the method
getTermsOfService
.
- Added the class
- Added the method
getMapThumbnailFile
which can be used to register and download a map thumbnail file. - Added the methods
sendPhoneNumberConfirmationCode
,resendPhoneNumberConfirmationCode
andcheckPhoneNumberConfirmationCode
which can be used to prevent an account from being deleted. - Added the convenience methods
joinChat
andleaveChat
which can be used instead ofsetChatMemberStatus
to manage the current user's membership in a chat. - Added the convenience method
getContacts
which can be used instead ofsearchContacts
to get all contacts. - Added the synchronous method
cleanFileName
which removes potentially dangerous characters from a file name. - Added the method
getChatMessageCount
which can be used to get the number of shared media. - Added the writable option
ignore_inline_thumbnails
which can be used to prevent file thumbnails sent by the server along with messages from being saved on the disk. - Added the writable option
prefer_ipv6
which can be used to prefer IPv6 connections over IPv4. - Added the writable option
disable_top_chats
which can be used to disable support for top chats. - Added the class
chatReportReasonCopyright
for reporting chats containing infringing content. - Added the method
clearAllDraftMessages
which can be used to delete all cloud drafts. - Added the read-only options
message_text_length_max
andmessage_caption_length_max
. - Added the read-only options
animation_search_bot_username
,photo_search_bot_username
andvenue_search_bot_username
containing usernames of bots which can be used in inline mode for animations, photos and venues search respectively. - Numerous optimizations and bug fixes:
- Fixed string encoding for .NET binding.
- Fixed building TDLib SDK for Universal Windows Platform for ARM with MSVC 2017.
- Fixed the Swift example project.
- Fixed the syntax error in the Python example.
- Sticker thumbnails can now have
webp
extensions if they are more likely to be in WEBP format.
Changes in 1.2.0 (20 Mar 2018):
- Added support for native .NET bindings through
C++/CLI
andC++/CX
. See using in .NET projects for more details. - Added a C# example. See README for build and usage instructions.
- Added a build and usage example of TDLib SDK for Universal Windows Platform. See README for detailed build and usage instructions. Also see Unigram, which is a full-featured client rewritten from scratch using TDLib SDK for Universal Windows Platform in less than 2 months.
- Added a Swift example. See README for build and usage instructions.
- Added an example of building TDLib for iOS, watchOS, tvOS, and also macOS. See README for detailed build instructions.
- Added README to C++ and python examples.
- Link Time Optimization is disabled by default. Use
-DTD_ENABLE_LTO=ON
CMake option and CMake >= 3.9 to enable it. updateNotificationSettings
is now automatically sent when the mute time expires for a chat.- Added automatic sending of a corresponding
chatAction
when a file is being uploaded. updateUserChatAction
withchatActionCancel
is now automatically sent when the timeout expires for an action.- Authorization states
authorizationStateWaitCode
andauthorizationStateWaitPassword
are now saved between library restarts for 5 minutes. - Added new message content type
messageWebsiteConnected
. - Added new text entity types
textEntityTypeCashtag
andtextEntityTypePhoneNumber
. - Added new update
updateUnreadMessageCount
, enabled when message database is used. - Method
joinChatByInviteLink
now returns the joinedchat
. - Method
getWebPagePreview
now acceptsformattedText
instead of plainstring
. - Added field
phone_number
toauthenticationCodeInfo
, which contains a phone number that is being authenticated. - Added field
is_secret
tomessageAnimation
,messagePhoto
,messageVideo
andmessageVideoNote
classes, which denotes whether the thumbnail for the content must be blurred and the content must be shown only while tapped. - Added field
expires_in
tomessageLocation
for live locations. - Added flag
can_be_reported
tochat
class. - Added flag
supports_streaming
to classesvideo
andinputMessageVideo
. - Added parameter
message_ids
toreportChat
, which can be used to report specific messages. - Added method
checkChatUsername
for checking whether a username can be set for a chat. - Added method
getRepliedMessage
, which returns a message that is replied by a given message. - Added method
getChatPinnedMessage
, which returns the pinned message from a chat. - Added method
searchStickers
to search by emoji for popular stickers suggested by the server. - Added method
searchStickerSets
to search by title and name for popular sticker sets suggested by the server. - Added method
searchInstalledStickerSets
to search by title and name for installed sticker sets. - Added methods for handling connected websites:
getConnectedWebsites
,disconnectWebsite
anddisconnectAllWebsites
. - Added method
getCountryCode
, which uses current user IP address to identify their country. - Added option
t_me_url
. - Fixed
BlackBerry
spelling indeviceTokenBlackBerryPush
. - Fixed return type of
getChatMessageByDate
method, which isMessage
and notMessages
. - Ensured that updateOption("my_id") comes before
updateAuthorizationState
withauthorizationStateReady
. - Numerous optimizations and bug fixes.
Changes in 1.1.1 (4 Feb 2018):
- Fixed C JSON bindings compilation error.
- Fixed locale-dependent JSON generation.
Changes in 1.1.0 (31 Jan 2018):
- Methods
td::Log::set_file_path
andtd_set_log_file_path
now return whether they succeeded. - Added methods
td::Log::set_max_file_size
andtd_set_log_max_file_size
for restricting maximum TDLib log size. - Added methods
td::Log::set_fatal_error_callback
andtd_set_log_fatal_error_callback
for providing callbacks on fatal errors. - JNI-bindings are now package-agnostic. Use CMake option
TD_ENABLE_JNI
to enable JNI-bindings. - Added a Java example. See README for build and usage instructions.
- Added support for text entities in media captions.
- Added new type
formattedText
containing a text with entities. - Replaced all string fields
caption
with fields of typeformattedText
. - Replaced fields
text
andentities
with the fieldtext
of typeformattedText
in classmessageText
. - Replaced fields
text
andentities
with the fieldtext
of typeformattedText
in classinputMessageText
. - Replaced fields
text
andtext_entities
with the fieldtext
of typeformattedText
in classgame
. - Removed field
parse_mode
from classinputMessageText
. - Added synchronous method
parseTextEntities
.
- Added new type
- updateNewMessage is now sent for all sent messages.
- updateChatLastMessage is now sent when any field of the last message in a chat changes.
- Reworked the
registerDevice
method:- Added parameter
other_user_ids
to methodregisterDevice
to support multiple accounts. - It is now possible to specify tokens for VoIP pushes, WNS, web Push API, Tizen Push Service as
DeviceToken
. - Added support for Apple Push Notification Service inside App Sandbox.
- Added parameter
- Added method
searchChatsOnServer
analogous tosearchChats
, but using server search. - Results from the
searchChatsOnServer
method are now excluded fromsearchPublicChats
results, sosearchChatsOnServer
(along withsearchContacts
) should be called wheneversearchPublicChats
is called to ensure that no results were omitted. - Added parameter
as_album
to methodgetPublicMessageLink
to enable getting public links for media albums. - Added field
html
to classpublicMessageLink
, containing HTML-code for message/message album embedding. - Added parameter
only_if_pending
to methodcancelDownloadFile
to allow keeping already started downloads. - Methods
createPrivateChat
,createBasicGroupChat
,createSupergroupChat
andcreateSecretChat
can now be called without a prior call togetUser
/getBasicGroup
/getSupergroup
/getSecretChat
. - Added parameter
force
to methodscreatePrivateChat
,createBasicGroupChat
andcreateSupergroupChat
to allow creating a chat without network requests. - Numerous optimizations and bug fixes.