tdlib / td

TDLib TDLib (Telegram Database library) is a cross-platform library for building Telegram clients. It can be easily used from almost any programming language. Table of Contents • Features • Examples and documentation • Dependencies • Building • Using in CMake C++ projects • Using in Java projects • Using in .NET projects • Using with other programming languages • License Features has many advantages. Notably is: • **Cross-platform**: can be used on Android, iOS, Windows, macOS, Linux, FreeBSD, OpenBSD, NetBSD, illumos, Windows Phone, WebAssembly, watchOS, tvOS, visionOS, Tizen, Cygwin. It should also work on other *nix systems with or without minimal effort. • **Multilanguage**: can be easily used with any programming language that is able to execute C functions. Additionally, it already has native Java (using ) bindings and .NET (using and ) bindings. • **Easy to use**: takes care of all network implementation details, encryption and local data storage. • **High-performance**: in the Telegram Bot API, each instance handles more than 25000 active bots simultaneously. • **Well-documented**: all API methods and public interfaces are fully documented. • **Consistent**: guarantees that all updates are delivered in the right order. • **Reliable**: remains stable on slow and unreliable Internet connections. • **Secure**: all local data is encrypted using a user-provided encryption key. • **Fully-asynchronous**: requests to don't block each other or anything else, responses are sent when they are available. Examples and documentation See our Getting Started tutorial for a description of basic TDLib concepts. Take a look at our examples. See a TDLib build instructions generator for detailed instructions on how to build TDLib. See description of our JSON, C++, Java and .NET interfaces. See the td_api.tl scheme or the automatically generated HTML documentation for a list of all available methods and classes. Dependencies depends on: • C++17 compatible compiler (Clang 5.0+, GCC 7.0+, MSVC 19.1+ (Visual Studio 2017.7+), Intel C++ Compiler 19+) • OpenSSL • zlib • gperf (build only) • CMake (3.10+, build only) • PHP (optional, for documentation generation) Building The simplest way to build is to use our TDLib build instructions generator. You need only to choose your programming language and target operating system to receive complete build instructions. In general, you need to install all dependencies, enter directory containing sources and compile them using CMake: To build on low memory devices you can run SplitSource.php script before compiling source code and compile only needed targets: In our tests clang 6.0 with libc++ required less than 500 MB of RAM per file and GCC 4.9/6.3 used less than 1 GB of RAM per file. Using in CMake C++ projects For C++ projects that use CMake, the best approach is to build as part of your project or to install it system-wide. There are several libraries that you could use in your CMake project: • Td::TdJson, Td::TdJsonStatic — dynamic and static version of a JSON interface. This has a simple C interface, so it can be easily used with any programming language that is able to execute C functions. See td_json_client documentation for more information. • Td::TdStatic — static library with C++ interface for general usage. See ClientManager and Client documentation for more information. For example, part of your CMakeLists.txt may look like this: Or you could install and then reference it in your CMakeLists.txt like this: See example/cpp/CMakeLists.txt. Using in Java projects provides native Java interface through JNI. To enable it, specify option to CMake. See example/java for example of using from Java and detailed build and usage instructions. Using in .NET projects provides native .NET interface through and . To enable it, specify option or respectively to CMake. .NET Core supports only since version 3.1 and only on Windows, so if older .NET Core is used or portability is needed, then JSON interface should be used through P/Invoke instead. See example/csharp for example of using from C# and detailed build and usage instructions. See example/uwp for example of using from C# UWP application and detailed build and usage instructions for Visual Studio Extension "TDLib for Universal Windows Platform". When is built with option enabled, documentation is removed from some files. You need to checkout these files to return documentation back: Using from other programming languages provides efficient native C++, Java, and .NET interfaces. But for most use cases we suggest to use the JSON interface, which can be easily used with any programming language that is able to execute C functions. See td_json_client documentation for detailed JSON interface description, the td_api.tl scheme or the automatically generated HTML documentation for a list of all available methods and classes. JSON interface adheres to semantic versioning and versions with the same major version number are binary and backward compatible, but the underlying API can be different for different minor and even patch versions. If you need to support different versions, then you can use a value of the option to find exact version to use appropriate API methods. See example/python/tdjson_example.py for an example of such usage. License is licensed under the terms of the Boost Software License. See LICENSE_1_0.txt for more information.