List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
getOption Class Referencefinal

Inherits Function.

Description

Returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization. Can be called synchronously for options "version" and "commit_hash".

Returns object_ptr<OptionValue>.

Public Fields

string name_
 The name of the option.
 

Public Types

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

Public Instance Methods

 getOption ()
 
 getOption (string const &name_)
 
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 = -1572495746
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ getOption() [1/2]

getOption ( )

Default constructor for a function, which returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization. Can be called synchronously for options "version" and "commit_hash".

Returns object_ptr<OptionValue>.

◆ getOption() [2/2]

getOption ( string const &  name_)
explicit

Creates a function, which returns the value of an option by its name. (Check the list of available options on https://core.telegram.org/tdlib/options.) Can be called before authorization. Can be called synchronously for options "version" and "commit_hash".

Returns object_ptr<OptionValue>.

Parameters
[in]name_The name of the option.

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