td::td_api::getOption Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	getOption ()
	getOption (string const &name_)
std::int32_t	get_id () const final
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (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.

Detailed 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>.

Constructor & Destructor Documentation

getOption() [1/2]

td::td_api::getOption::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]

td::td_api::getOption::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

get_id()

std::int32_t td::td_api::getOption::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

store()

void td::td_api::getOption::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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h