tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::setTdlibParameters Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::setTdlibParameters:
td::td_api::Function td::TlObject

Public Types

using ReturnType = object_ptr< ok >
 Typedef for the type returned by the function.
 

Public Member Functions

 setTdlibParameters ()
 
 setTdlibParameters (bool use_test_dc_, string const &database_directory_, string const &files_directory_, bytes const &database_encryption_key_, bool use_file_database_, bool use_chat_info_database_, bool use_message_database_, bool use_secret_chats_, int32 api_id_, string const &api_hash_, string const &system_language_code_, string const &device_model_, string const &system_version_, string const &application_version_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

bool use_test_dc_
 Pass true to use Telegram test environment instead of the production environment.
 
string database_directory_
 The path to the directory for the persistent database; if empty, the current working directory will be used.
 
string files_directory_
 The path to the directory for storing files; if empty, database_directory will be used.
 
bytes database_encryption_key_
 Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned.
 
bool use_file_database_
 Pass true to keep information about downloaded and uploaded files between application restarts.
 
bool use_chat_info_database_
 Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies use_file_database.
 
bool use_message_database_
 Pass true to keep cache of chats and messages between restarts. Implies use_chat_info_database.
 
bool use_secret_chats_
 Pass true to enable support for secret chats.
 
int32 api_id_
 Application identifier for Telegram API access, which can be obtained at https://my.telegram.org.
 
string api_hash_
 Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org.
 
string system_language_code_
 IETF language tag of the user&#x27;s operating system language; must be non-empty.
 
string device_model_
 Model of the device the application is being run on; must be non-empty.
 
string system_version_
 Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib.
 
string application_version_
 Application version; must be non-empty.
 

Static Public Attributes

static const std::int32_t ID = -775883218
 Identifier uniquely determining a type of the object.
 

Detailed Description

Sets bootstrap parameters for TDLib initialization. Call once after receiving authorizationStateWaitTdlibParameters from updateAuthorizationState.

Returns object_ptr<Ok>.

Definition at line 133923 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 133995 of file td_api.h.

Constructor & Destructor Documentation

◆ setTdlibParameters() [1/2]

td::td_api::setTdlibParameters::setTdlibParameters ( )

Default constructor for a function, which sets bootstrap parameters for TDLib initialization. Call once after receiving authorizationStateWaitTdlibParameters from updateAuthorizationState.

Returns object_ptr<Ok>.

◆ setTdlibParameters() [2/2]

td::td_api::setTdlibParameters::setTdlibParameters ( bool  use_test_dc_,
string const &  database_directory_,
string const &  files_directory_,
bytes const &  database_encryption_key_,
bool  use_file_database_,
bool  use_chat_info_database_,
bool  use_message_database_,
bool  use_secret_chats_,
int32  api_id_,
string const &  api_hash_,
string const &  system_language_code_,
string const &  device_model_,
string const &  system_version_,
string const &  application_version_ 
)

Creates a function, which sets bootstrap parameters for TDLib initialization. Call once after receiving authorizationStateWaitTdlibParameters from updateAuthorizationState.

Returns object_ptr<Ok>.

Parameters
[in]use_test_dc_Pass true to use Telegram test environment instead of the production environment.
[in]database_directory_The path to the directory for the persistent database; if empty, the current working directory will be used.
[in]files_directory_The path to the directory for storing files; if empty, database_directory will be used.
[in]database_encryption_key_Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned.
[in]use_file_database_Pass true to keep information about downloaded and uploaded files between application restarts.
[in]use_chat_info_database_Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies use_file_database.
[in]use_message_database_Pass true to keep cache of chats and messages between restarts. Implies use_chat_info_database.
[in]use_secret_chats_Pass true to enable support for secret chats.
[in]api_id_Application identifier for Telegram API access, which can be obtained at https://my.telegram.org.
[in]api_hash_Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org.
[in]system_language_code_IETF language tag of the user&#x27;s operating system language; must be non-empty.
[in]device_model_Model of the device the application is being run on; must be non-empty.
[in]system_version_Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib.
[in]application_version_Application version; must be non-empty.

Member Function Documentation

◆ store()

void td::td_api::setTdlibParameters::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ api_hash_

string td::td_api::setTdlibParameters::api_hash_

Application identifier hash for Telegram API access, which can be obtained at https://my.telegram.org.

Definition at line 133952 of file td_api.h.

◆ api_id_

int32 td::td_api::setTdlibParameters::api_id_

Application identifier for Telegram API access, which can be obtained at https://my.telegram.org.

Definition at line 133950 of file td_api.h.

◆ application_version_

string td::td_api::setTdlibParameters::application_version_

Application version; must be non-empty.

Definition at line 133960 of file td_api.h.

◆ database_directory_

string td::td_api::setTdlibParameters::database_directory_

The path to the directory for the persistent database; if empty, the current working directory will be used.

Definition at line 133936 of file td_api.h.

◆ database_encryption_key_

bytes td::td_api::setTdlibParameters::database_encryption_key_

Encryption key for the database. If the encryption key is invalid, then an error with code 401 will be returned.

Definition at line 133940 of file td_api.h.

◆ device_model_

string td::td_api::setTdlibParameters::device_model_

Model of the device the application is being run on; must be non-empty.

Definition at line 133956 of file td_api.h.

◆ files_directory_

string td::td_api::setTdlibParameters::files_directory_

The path to the directory for storing files; if empty, database_directory will be used.

Definition at line 133938 of file td_api.h.

◆ ID

const std::int32_t td::td_api::setTdlibParameters::ID = -775883218
static

Identifier uniquely determining a type of the object.

Definition at line 133992 of file td_api.h.

◆ system_language_code_

string td::td_api::setTdlibParameters::system_language_code_

IETF language tag of the user&#x27;s operating system language; must be non-empty.

Definition at line 133954 of file td_api.h.

◆ system_version_

string td::td_api::setTdlibParameters::system_version_

Version of the operating system the application is being run on. If empty, the version is automatically detected by TDLib.

Definition at line 133958 of file td_api.h.

◆ use_chat_info_database_

bool td::td_api::setTdlibParameters::use_chat_info_database_

Pass true to keep cache of users, basic groups, supergroups, channels and secret chats between restarts. Implies use_file_database.

Definition at line 133944 of file td_api.h.

◆ use_file_database_

bool td::td_api::setTdlibParameters::use_file_database_

Pass true to keep information about downloaded and uploaded files between application restarts.

Definition at line 133942 of file td_api.h.

◆ use_message_database_

bool td::td_api::setTdlibParameters::use_message_database_

Pass true to keep cache of chats and messages between restarts. Implies use_chat_info_database.

Definition at line 133946 of file td_api.h.

◆ use_secret_chats_

bool td::td_api::setTdlibParameters::use_secret_chats_

Pass true to enable support for secret chats.

Definition at line 133948 of file td_api.h.

◆ use_test_dc_

bool td::td_api::setTdlibParameters::use_test_dc_

Pass true to use Telegram test environment instead of the production environment.

Definition at line 133934 of file td_api.h.


The documentation for this class was generated from the following file: