List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
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 Fields

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

Public Types

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

Public Instance Methods

 getLanguagePackString ()
 
 getLanguagePackString (string const &language_pack_database_path_, string const &localization_target_, string const &language_pack_id_, string const &key_)
 
std::int32_t get_id () const final
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from 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
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getLanguagePackString() [1/2]

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.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ 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: