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

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

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

Public Types

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

Public Member Functions

 searchContacts ()
 
 searchContacts (string const &query_, int32 limit_)
 
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 query_
 Query to search for; may be empty to return all contacts.
 
int32 limit_
 The maximum number of users to be returned.
 

Static Public Attributes

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

Detailed Description

Searches for the specified query in the first names, last names and usernames of the known user contacts.

Returns object_ptr<Users>.

Definition at line 123826 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 123862 of file td_api.h.

Constructor & Destructor Documentation

◆ searchContacts() [1/2]

td::td_api::searchContacts::searchContacts ( )

Default constructor for a function, which searches for the specified query in the first names, last names and usernames of the known user contacts.

Returns object_ptr<Users>.

◆ searchContacts() [2/2]

td::td_api::searchContacts::searchContacts ( string const &  query_,
int32  limit_ 
)

Creates a function, which searches for the specified query in the first names, last names and usernames of the known user contacts.

Returns object_ptr<Users>.

Parameters
[in]query_Query to search for; may be empty to return all contacts.
[in]limit_The maximum number of users to be returned.

Member Function Documentation

◆ store()

void td::td_api::searchContacts::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::searchContacts::ID = -1794690715
static

Identifier uniquely determining a type of the object.

Definition at line 123859 of file td_api.h.

◆ limit_

int32 td::td_api::searchContacts::limit_

The maximum number of users to be returned.

Definition at line 123839 of file td_api.h.

◆ query_

string td::td_api::searchContacts::query_

Query to search for; may be empty to return all contacts.

Definition at line 123837 of file td_api.h.


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