tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::sendPhoneNumberCode Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::sendPhoneNumberCode:
td::td_api::Function td::TlObject

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 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, in international format.
 
object_ptr< phoneNumberAuthenticationSettingssettings_
 Settings for the authentication of the user&#x27;s phone number; pass null to use default settings.
 
object_ptr< PhoneNumberCodeTypetype_
 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.
 

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

Definition at line 126634 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 126673 of file td_api.h.

Constructor & Destructor Documentation

◆ sendPhoneNumberCode() [1/2]

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

td::td_api::sendPhoneNumberCode::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&#x27;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 td::td_api::sendPhoneNumberCode::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.

Member Data Documentation

◆ ID

const std::int32_t td::td_api::sendPhoneNumberCode::ID = 1084112144
static

Identifier uniquely determining a type of the object.

Definition at line 126670 of file td_api.h.

◆ phone_number_

string td::td_api::sendPhoneNumberCode::phone_number_

The phone number, in international format.

Definition at line 126645 of file td_api.h.

◆ settings_

object_ptr<phoneNumberAuthenticationSettings> td::td_api::sendPhoneNumberCode::settings_

Settings for the authentication of the user&#x27;s phone number; pass null to use default settings.

Definition at line 126647 of file td_api.h.

◆ type_

object_ptr<PhoneNumberCodeType> td::td_api::sendPhoneNumberCode::type_

Type of the request for which the code is sent.

Definition at line 126649 of file td_api.h.


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