TDLib
Loading...
Searching...
No Matches
td::td_api::setAuthenticationPhoneNumber Class Referencefinal

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 setAuthenticationPhoneNumber ()
 
 setAuthenticationPhoneNumber (string const &phone_number_, object_ptr< phoneNumberAuthenticationSettings > &&settings_)
 
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
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string phone_number_
 The phone number of the user, in international format.
 
object_ptr< phoneNumberAuthenticationSettingssettings_
 Settings for the authentication of the user's phone number; pass null to use default settings.
 

Static Public Attributes

static const std::int32_t ID = 868276259
 Identifier uniquely determining a type of the object.
 

Detailed Description

Sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword.

Returns object_ptr<Ok>.

Constructor & Destructor Documentation

◆ setAuthenticationPhoneNumber() [1/2]

td::td_api::setAuthenticationPhoneNumber::setAuthenticationPhoneNumber ( )

Default constructor for a function, which sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword.

Returns object_ptr<Ok>.

◆ setAuthenticationPhoneNumber() [2/2]

td::td_api::setAuthenticationPhoneNumber::setAuthenticationPhoneNumber ( string const &  phone_number_,
object_ptr< phoneNumberAuthenticationSettings > &&  settings_ 
)

Creates a function, which sets the phone number of the user and sends an authentication code to the user. Works only when the current authorization state is authorizationStateWaitPhoneNumber, or if there is no pending authentication query and the current authorization state is authorizationStateWaitEmailAddress, authorizationStateWaitEmailCode, authorizationStateWaitCode, authorizationStateWaitRegistration, or authorizationStateWaitPassword.

Returns object_ptr<Ok>.

Parameters
[in]phone_number_The phone number of the user, in international format.
[in]settings_Settings for the authentication of the user's phone number; pass null to use default settings.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::setAuthenticationPhoneNumber::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

void td::td_api::setAuthenticationPhoneNumber::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 td::TlObject.


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