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

Inherits Function.

Description

Adds a user to the contact list or edits an existing contact by their user identifier.

Returns object_ptr<Ok>.

Public Types

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

Public Member Functions

 addContact ()
 addContact (int53 user_id_, object_ptr< importedContact > &&contact_, bool share_phone_number_)
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

object_ptr< importedContact > contact_
 The contact to add or edit; phone number may be empty and needs to be specified only if known.
bool share_phone_number_
 Pass true to share the current user's phone number with the new contact. A corresponding rule to userPrivacySettingShowPhoneNumber will be added if needed. Use the field userFullInfo.need_phone_number_privacy_exception to check whether the current user needs to be asked to share their phone number.
int53 user_id_
 Identifier of the user.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ addContact() [1/2]

addContact ( )

Default constructor for a function, which adds a user to the contact list or edits an existing contact by their user identifier.

Returns object_ptr<Ok>.

◆ addContact() [2/2]

addContact ( int53 user_id_,
object_ptr< importedContact > && contact_,
bool share_phone_number_ )

Creates a function, which adds a user to the contact list or edits an existing contact by their user identifier.

Returns object_ptr<Ok>.

Parameters
[in]user_id_Identifier of the user.
[in]contact_The contact to add or edit; phone number may be empty and needs to be specified only if known.
[in]share_phone_number_Pass true to share the current user's phone number with the new contact. A corresponding rule to userPrivacySettingShowPhoneNumber will be added if needed. Use the field userFullInfo.need_phone_number_privacy_exception to check whether the current user needs to be asked to share their phone number.

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: