recoverAuthenticationPassword Class Reference

Inherits Function.

Description

Recovers the 2-step verification password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword.

Returns object_ptr<Ok>.

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

Public Member Functions
	recoverAuthenticationPassword ()
	recoverAuthenticationPassword (string const &recovery_code_, string const &new_password_, string const &new_hint_)
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	new_hint_
	New password hint; may be empty.
string	new_password_
	New 2-step verification password of the user; may be empty to remove the password.
string	recovery_code_
	Recovery code to check.

Static Public Attributes
static const std::int32_t	ID = -131001053
	Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

recoverAuthenticationPassword() [1/2]

recoverAuthenticationPassword

(

)

Default constructor for a function, which recovers the 2-step verification password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword.

Returns object_ptr<Ok>.

recoverAuthenticationPassword() [2/2]

recoverAuthenticationPassword	(	string const &	recovery_code_,
		string const &	new_password_,
		string const &	new_hint_ )

Creates a function, which recovers the 2-step verification password with a password recovery code sent to an email address that was previously set up. Works only when the current authorization state is authorizationStateWaitPassword.

Returns object_ptr<Ok>.

Parameters

[in]	recovery_code_	Recovery code to check.
[in]	new_password_	New 2-step verification password of the user; may be empty to remove the password.
[in]	new_hint_	New password hint; may be empty.

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

Implements TlObject.

---

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

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