TDLib
Loading...
Searching...
No Matches
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 Types

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

Public Member Functions

 getOption ()
 getOption (string const &name_)
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 name_
 The name of the option.

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.

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: