TDLib
Loading...
Searching...
No Matches
getLanguagePackString Class Referencefinal

Inherits Function.

Description

Returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. Can be called synchronously.

Returns object_ptr<LanguagePackStringValue>.

Public Types

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

Public Member Functions

 getLanguagePackString ()
 getLanguagePackString (string const &language_pack_database_path_, string const &localization_target_, string const &language_pack_id_, string const &key_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

string key_
 Language pack key of the string to be returned.
string language_pack_database_path_
 Path to the language pack database in which strings are stored.
string language_pack_id_
 Language pack identifier.
string localization_target_
 Localization target to which the language pack belongs.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getLanguagePackString() [1/2]

getLanguagePackString ( )

Default constructor for a function, which returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. Can be called synchronously.

Returns object_ptr<LanguagePackStringValue>.

◆ getLanguagePackString() [2/2]

getLanguagePackString ( string const & language_pack_database_path_,
string const & localization_target_,
string const & language_pack_id_,
string const & key_ )

Creates a function, which returns a string stored in the local database from the specified localization target and language pack by its key. Returns a 404 error if the string is not found. Can be called synchronously.

Returns object_ptr<LanguagePackStringValue>.

Parameters
[in]language_pack_database_path_Path to the language pack database in which strings are stored.
[in]localization_target_Localization target to which the language pack belongs.
[in]language_pack_id_Language pack identifier.
[in]key_Language pack key of the string to be returned.

Member Function Documentation

◆ store()

void 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 TlObject.


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