TDLib
Loading...
Searching...
No Matches
sendPhoneNumberCode Class Referencefinal

Inherits Function.

Description

Sends a code to the specified phone number. Aborts previous phone number verification if there was one. On success, returns information about the sent code.

Returns object_ptr<AuthenticationCodeInfo>.

Public Types

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

Public Member Functions

 sendPhoneNumberCode ()
 sendPhoneNumberCode (string const &phone_number_, object_ptr< phoneNumberAuthenticationSettings > &&settings_, object_ptr< PhoneNumberCodeType > &&type_)
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 phone_number_
 The phone number, in international format.
object_ptr< phoneNumberAuthenticationSettings > settings_
 Settings for the authentication of the user's phone number; pass null to use default settings.
object_ptr< PhoneNumberCodeType > type_
 Type of the request for which the code is sent.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ sendPhoneNumberCode() [1/2]

sendPhoneNumberCode ( )

Default constructor for a function, which sends a code to the specified phone number. Aborts previous phone number verification if there was one. On success, returns information about the sent code.

Returns object_ptr<AuthenticationCodeInfo>.

◆ sendPhoneNumberCode() [2/2]

sendPhoneNumberCode ( string const & phone_number_,
object_ptr< phoneNumberAuthenticationSettings > && settings_,
object_ptr< PhoneNumberCodeType > && type_ )

Creates a function, which sends a code to the specified phone number. Aborts previous phone number verification if there was one. On success, returns information about the sent code.

Returns object_ptr<AuthenticationCodeInfo>.

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

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: