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

Inherits Function.

Description

Changes the password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed.

Returns object_ptr<PasswordState>.

Public Fields

string old_password_
 Previous password of the user.
 
string new_password_
 New password of the user; may be empty to remove the password.
 
string new_hint_
 New password hint; may be empty.
 
bool set_recovery_email_address_
 Pass true if the recovery email address must be changed.
 
string new_recovery_email_address_
 New recovery email address; may be empty.
 

Public Types

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

Public Instance Methods

 setPassword ()
 
 setPassword (string const &old_password_, string const &new_password_, string const &new_hint_, bool set_recovery_email_address_, string const &new_recovery_email_address_)
 
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 = -1193589027
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ setPassword() [1/2]

Default constructor for a function, which changes the password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed.

Returns object_ptr<PasswordState>.

◆ setPassword() [2/2]

setPassword ( string const &  old_password_,
string const &  new_password_,
string const &  new_hint_,
bool  set_recovery_email_address_,
string const &  new_recovery_email_address_ 
)

Creates a function, which changes the password for the current user. If a new recovery email address is specified, then the change will not be applied until the new recovery email address is confirmed.

Returns object_ptr<PasswordState>.

Parameters
[in]old_password_Previous password of the user.
[in]new_password_New password of the user; may be empty to remove the password.
[in]new_hint_New password hint; may be empty.
[in]set_recovery_email_address_Pass true if the recovery email address must be changed.
[in]new_recovery_email_address_New recovery email address; may be empty.

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: