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::searchUserByPhoneNumber Class Referencefinal

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

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

Public Types

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

Public Member Functions

 searchUserByPhoneNumber ()
 
 searchUserByPhoneNumber (string const &phone_number_, bool only_local_)
 
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_
 Phone number to search for.
 
bool only_local_
 Pass true to get only locally available information without sending network requests.
 

Static Public Attributes

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

Detailed Description

Searches a user by their phone number. Returns a 404 error if the user can&#x27;t be found.

Returns object_ptr<User>.

Definition at line 125174 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 125210 of file td_api.h.

Constructor & Destructor Documentation

◆ searchUserByPhoneNumber() [1/2]

td::td_api::searchUserByPhoneNumber::searchUserByPhoneNumber ( )

Default constructor for a function, which searches a user by their phone number. Returns a 404 error if the user can&#x27;t be found.

Returns object_ptr<User>.

◆ searchUserByPhoneNumber() [2/2]

td::td_api::searchUserByPhoneNumber::searchUserByPhoneNumber ( string const &  phone_number_,
bool  only_local_ 
)

Creates a function, which searches a user by their phone number. Returns a 404 error if the user can&#x27;t be found.

Returns object_ptr<User>.

Parameters
[in]phone_number_Phone number to search for.
[in]only_local_Pass true to get only locally available information without sending network requests.

Member Function Documentation

◆ store()

void td::td_api::searchUserByPhoneNumber::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::searchUserByPhoneNumber::ID = -343757368
static

Identifier uniquely determining a type of the object.

Definition at line 125207 of file td_api.h.

◆ only_local_

bool td::td_api::searchUserByPhoneNumber::only_local_

Pass true to get only locally available information without sending network requests.

Definition at line 125187 of file td_api.h.

◆ phone_number_

string td::td_api::searchUserByPhoneNumber::phone_number_

Phone number to search for.

Definition at line 125185 of file td_api.h.


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