diff --git a/data/web/core.telegram.org/tdlib/docs.html b/data/web/core.telegram.org/tdlib/docs.html deleted file mode 100644 index a6dad42d1a..0000000000 --- a/data/web/core.telegram.org/tdlib/docs.html +++ /dev/null @@ -1,210 +0,0 @@ - - - -
- - - - -TDLib (Telegram Database library) is a cross-platform library for building Telegram clients. It can be easily used from almost any programming language.
-TDLib
has many advantages. Notably TDLib
is:
TDLib
can be used on Android, iOS, Windows, macOS, Linux, FreeBSD, OpenBSD, NetBSD, illumos, Windows Phone, WebAssembly, watchOS, tvOS, Tizen, Cygwin. It should also work on other *nix systems with or without minimal effort.TDLib
can be easily used with any programming language that is able to execute C functions. Additionally it already has native Java (using JNI
) bindings and .NET (using C++/CLI
and C++/CX
) bindings.TDLib
takes care of all network implementation details, encryption and local data storage.TDLib
instance handles more than 24000 active bots simultaneously.TDLib
API methods and public interfaces are fully documented.TDLib
guarantees that all updates are delivered in the right order.TDLib
remains stable on slow and unreliable Internet connections.TDLib
don't block each other or anything else, responses are sent when they are available.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 TDLib
methods and classes.
TDLib
depends on:
The simplest way to build TDLib
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 TDLib
dependencies, enter directory containing TDLib
sources and compile them using CMake:
To build TDLib
on low memory devices you can run SplitSource.php script before compiling main TDLib
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.
-For C++ projects that use CMake, the best approach is to build TDLib
as part of your project or to install it system-wide.
There are several libraries that you could use in your CMake project:
-For example, part of your CMakeLists.txt may look like this:
Or you could install TDLib
and then reference it in your CMakeLists.txt like this:
See example/cpp/CMakeLists.txt.
-TDLib
provides native Java interface through JNI. To enable it, specify option -DTD_ENABLE_JNI=ON
to CMake.
See example/java for example of using TDLib
from Java and detailed build and usage instructions.
TDLib
provides native .NET interface through C++/CLI
and C++/CX
. To enable it, specify option -DTD_ENABLE_DOTNET=ON
to CMake. .NET Core supports C++/CLI
only since version 3.1 and only on Windows, so if older .NET Core is used or portability is needed, then TDLib
JSON interface should be used through P/Invoke instead.
See example/csharp for example of using TDLib
from C# and detailed build and usage instructions. See example/uwp for example of using TDLib
from C# UWP application and detailed build and usage instructions for Visual Studio Extension "TDLib for Universal Windows Platform".
When TDLib
is built with TD_ENABLE_DOTNET
option enabled, C++
documentation is removed from some files. You need to checkout these files to return C++
documentation back:
TDLib
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 TDLib
methods and classes.
TDLib
JSON interface adheres to semantic versioning and versions with the same major version number are binary and backward compatible, but the underlying TDLib
API can be different for different minor and even patch versions. If you need to support different TDLib
versions, then you can use a value of the version
option to find exact TDLib
version to use appropriate API methods.
See example/python/tdjson_example.py for an example of such usage.
-TDLib
is licensed under the terms of the Boost Software License. See LICENSE_1_0.txt for more information.
Contains declarations of all functions and types which represent a public TDLib interface.
+Go to the source code of this file.
++Typedefs | |
using | int32 = std::int32_t |
using | int53 = std::int64_t |
using | int64 = std::int64_t |
using | string = std::string |
using | bytes = std::string |
template<class Type > | |
using | array = std::vector< Type > |
using | BaseObject = ::td::TlObject |
template<class Type > | |
using | object_ptr = ::td::tl_object_ptr< Type > |
+Functions | |
template<class Type , class... Args> | |
object_ptr< Type > | make_object (Args &&... args) |
template<class ToType , class FromType > | |
object_ptr< ToType > | move_object_as (FromType &&from) |
std::string | to_string (const BaseObject &value) |
template<class T > | |
std::string | to_string (const object_ptr< T > &value) |
template<class T > | |
std::string | to_string (const std::vector< object_ptr< T >> &values) |
using int32 = std::int32_t | +
This type is used to store 32-bit signed integers, which can be represented as Number in JSON.
+ +using int53 = std::int64_t | +
This type is used to store 53-bit signed integers, which can be represented as Number in JSON.
+ +using int64 = std::int64_t | +
This type is used to store 64-bit signed integers, which can't be represented as Number in JSON and are represented as String instead.
+ +using string = std::string | +
This type is used to store UTF-8 strings.
+ +using bytes = std::string | +
This type is used to store arbitrary sequences of bytes. In JSON interface the bytes are base64-encoded.
+ +using array = std::vector<Type> | +
This type is used to store a list of objects of any type and is represented as Array in JSON.
+ +using BaseObject = ::td::TlObject | +
This class is a base class for all TDLib API classes and functions.
+ +using object_ptr = ::td::tl_object_ptr<Type> | +
A smart wrapper to store a pointer to a TDLib API object. Can be treated as an analogue of std::unique_ptr.
+ +object_ptr<Type> td::td_api::make_object | +( | +Args &&... | +args | ) | ++ |
A function to create a dynamically allocated TDLib API object. Can be treated as an analogue of std::make_unique. Usage example:
Type | Type of an object to construct. |
[in] | args | Arguments to pass to the object constructor. |
object_ptr<ToType> td::td_api::move_object_as | +( | +FromType && | +from | ) | ++ |
A function to cast a wrapped in td::td_api::object_ptr TDLib API object to its subclass or superclass. Casting an object to an incorrect type will lead to undefined behaviour. Usage example:
ToType | Type of a TDLib API object to move to. |
FromType | Type of a TDLib API object to move from, this is auto-deduced. |
[in] | from | Wrapped in td::td_api::object_ptr pointer to a TDLib API object. |
std::string td::td_api::to_string | +( | +const BaseObject & | +value | ) | ++ |
Returns a string representation of a TDLib API object.
[in] | value | The object. |
std::string td::td_api::to_string | +( | +const object_ptr< T > & | +value | ) | ++ |
Returns a string representation of a TDLib API object.
T | Object type, auto-deduced. |
[in] | value | The object. |
std::string td::td_api::to_string | +( | +const std::vector< object_ptr< T >> & | +values | ) | ++ |
Returns a string representation of a list of TDLib API objects.
T | Object type, auto-deduced. |
[in] | values | The objects. |
C interface for interaction with TDLib via JSON-serialized objects. Can be used to easily integrate TDLib with any programming language which supports calling C functions and is able to work with JSON.
-The JSON serialization of TDLib API objects is straightforward: all API objects are represented as JSON objects with the same keys as the API object field names. The object type name is stored in the special field "@type" which is optional in places where type is uniquely determined by the context. Fields of Bool type are stored as Boolean, fields of int32, int53, and double types are stored as Number, fields of int64 and string types are stored as String, fields of bytes type are base64 encoded and then stored as String, fields of array type are stored as Array.
-The main TDLib interface is asynchronous. To match requests with a corresponding response, the field "@extra" can be added to the request object. The corresponding response will have an "@extra" field with exactly the same value. Each returned object will have an "@client_id" field, containing the identifier of the client for which a response or an update was received.
-A TDLib client instance can be created through td_create_client_id. Requests can be sent using td_send and the received client identifier. New updates and responses to requests can be received through td_receive from any thread after the first request has been sent to the client instance. This function must not be called simultaneously from two different threads. Also note that all updates and responses to requests must be applied in the order they were received for consistency. Some TDLib requests can be executed synchronously from any thread using td_execute. TDLib client instances are destroyed automatically after they are closed. All TDLib client instances must be closed before application termination to ensure data consistency.
-General pattern of usage:
Alternatively, you can use old TDLib JSON interface, which will be removed in TDLib 2.0.0.
-Objects and functions serialization to JSON is the same for both JSON interfaces.
-The main TDLib interface is asynchronous. To match requests with a corresponding response a field "@extra" can be added to the request object. The corresponding response will have an "@extra" field with exactly the same value.
-A TDLib client instance can be created through td_json_client_create. Requests then can be sent using td_json_client_send from any thread. New updates and request responses can be received through td_json_client_receive from any thread. This function must not be called simultaneously from two different threads. Also note that all updates and request responses must be applied in the order they were received to ensure consistency. Given this information, it's advisable to call this function from a dedicated thread. Some service TDLib requests can be executed synchronously from any thread by using td_json_client_execute. The TDLib client instance can be destroyed via td_json_client_destroy.
-General pattern of usage:
Go to the source code of this file.
--Typedefs | |
typedef void(* | td_log_message_callback_ptr) (int verbosity_level, const char *message) |
-Functions | |
int | td_create_client_id () |
void | td_send (int client_id, const char *request) |
const char * | td_receive (double timeout) |
const char * | td_execute (const char *request) |
void | td_set_log_message_callback (int max_verbosity_level, td_log_message_callback_ptr callback) |
void * | td_json_client_create () |
void | td_json_client_send (void *client, const char *request) |
const char * | td_json_client_receive (void *client, double timeout) |
const char * | td_json_client_execute (void *client, const char *request) |
void | td_json_client_destroy (void *client) |
typedef void(* td_log_message_callback_ptr) (int verbosity_level, const char *message) | -
A type of callback function that will be called when a message is added to the internal TDLib log.
-verbosity_level | Log verbosity level with which the message was added (-1 - 1024). If 0, then TDLib will crash as soon as the callback returns. None of the TDLib methods can be called from the callback. |
message | Null-terminated string with the logged message. |
int td_create_client_id | -( | -) | -- |
Returns an opaque identifier of a new TDLib instance. The TDLib instance will not send updates until the first request is sent to it.
void td_send | -( | -int | -client_id, | -
- | - | const char * | -request | -
- | ) | -- |
Sends request to the TDLib client. May be called from any thread.
[in] | client_id | TDLib client identifier. |
[in] | request | JSON-serialized null-terminated request to TDLib. |
const char* td_receive | -( | -double | -timeout | ) | -- |
Receives incoming updates and request responses. Must not be called simultaneously from two different threads. The returned pointer can be used until the next call to td_receive or td_execute, after which it will be deallocated by TDLib.
[in] | timeout | The maximum number of seconds allowed for this function to wait for new data. |
const char* td_execute | -( | -const char * | -request | ) | -- |
Synchronously executes a TDLib request. A request can be executed synchronously, only if it is documented with "Can be called synchronously". The returned pointer can be used until the next call to td_receive or td_execute, after which it will be deallocated by TDLib.
[in] | request | JSON-serialized null-terminated request to TDLib. |
void td_set_log_message_callback | -( | -int | -max_verbosity_level, | -
- | - | td_log_message_callback_ptr | -callback | -
- | ) | -- |
Sets the callback that will be called when a message is added to the internal TDLib log. None of the TDLib methods can be called from the callback. By default the callback is not set.
-[in] | max_verbosity_level | The maximum verbosity level of messages for which the callback will be called. |
[in] | callback | Callback that will be called when a message is added to the internal TDLib log. Pass nullptr to remove the callback. |
void* td_json_client_create | -( | -) | -- |
Creates a new instance of TDLib.
void td_json_client_send | -( | -void * | -client, | -
- | - | const char * | -request | -
- | ) | -- |
Sends request to the TDLib client. May be called from any thread.
[in] | client | The client. |
[in] | request | JSON-serialized null-terminated request to TDLib. |
const char* td_json_client_receive | -( | -void * | -client, | -
- | - | double | -timeout | -
- | ) | -- |
Receives incoming updates and request responses from the TDLib client. May be called from any thread, but must not be called simultaneously from two different threads. Returned pointer will be deallocated by TDLib during next call to td_json_client_receive or td_json_client_execute in the same thread, so it can't be used after that.
[in] | client | The client. |
[in] | timeout | The maximum number of seconds allowed for this function to wait for new data. |
const char* td_json_client_execute | -( | -void * | -client, | -
- | - | const char * | -request | -
- | ) | -- |
Synchronously executes TDLib request. May be called from any thread. Only a few requests can be executed synchronously. Returned pointer will be deallocated by TDLib during next call to td_json_client_receive or td_json_client_execute in the same thread, so it can't be used after that.
[in] | client | The client. Currently ignored for all requests, so NULL can be passed. |
[in] | request | JSON-serialized null-terminated request to TDLib. |
void td_json_client_destroy | -( | -void * | -client | ) | -- |
Destroys the TDLib client instance. After this is called the client instance must not be used anymore.
[in] | client | The client. |