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

Inherits Object.

Description

Contains settings for the authentication of the user's phone number.

Public Member Functions

 phoneNumberAuthenticationSettings ()
 phoneNumberAuthenticationSettings (bool allow_flash_call_, bool allow_missed_call_, bool is_current_phone_number_, bool has_unknown_phone_number_, bool allow_sms_retriever_api_, object_ptr< FirebaseAuthenticationSettings > &&firebase_authentication_settings_, array< string > &&authentication_tokens_)
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

bool allow_flash_call_
 Pass true if the authentication code may be sent via a flash call to the specified phone number.
bool allow_missed_call_
 Pass true if the authentication code may be sent via a missed call to the specified phone number.
bool allow_sms_retriever_api_
 For official applications only. True, if the application can use Android SMS Retriever API (requires Google Play Services >= 10.2) to automatically receive the authentication code from the SMS. See https://developers.google.com/identity/sms-retriever/ for more details.
array< string > authentication_tokens_
 List of up to 20 authentication tokens, recently received in updateOption("authentication_token") in previously logged out sessions; for setAuthenticationPhoneNumber only.
object_ptr< FirebaseAuthenticationSettings > firebase_authentication_settings_
 For official Android and iOS applications only; pass null otherwise. Settings for Firebase Authentication.
bool has_unknown_phone_number_
 Pass true if there is a SIM card in the current device, but it is not possible to check whether phone number matches.
bool is_current_phone_number_
 Pass true if the authenticated phone number is used on the current device.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ phoneNumberAuthenticationSettings() [1/2]

phoneNumberAuthenticationSettings ( )

Contains settings for the authentication of the user's phone number.

◆ phoneNumberAuthenticationSettings() [2/2]

phoneNumberAuthenticationSettings ( bool allow_flash_call_,
bool allow_missed_call_,
bool is_current_phone_number_,
bool has_unknown_phone_number_,
bool allow_sms_retriever_api_,
object_ptr< FirebaseAuthenticationSettings > && firebase_authentication_settings_,
array< string > && authentication_tokens_ )

Contains settings for the authentication of the user's phone number.

Parameters
[in]allow_flash_call_Pass true if the authentication code may be sent via a flash call to the specified phone number.
[in]allow_missed_call_Pass true if the authentication code may be sent via a missed call to the specified phone number.
[in]is_current_phone_number_Pass true if the authenticated phone number is used on the current device.
[in]has_unknown_phone_number_Pass true if there is a SIM card in the current device, but it is not possible to check whether phone number matches.
[in]allow_sms_retriever_api_For official applications only. True, if the application can use Android SMS Retriever API (requires Google Play Services >= 10.2) to automatically receive the authentication code from the SMS. See https://developers.google.com/identity/sms-retriever/ for more details.
[in]firebase_authentication_settings_For official Android and iOS applications only; pass null otherwise. Settings for Firebase Authentication.
[in]authentication_tokens_List of up to 20 authentication tokens, recently received in updateOption("authentication_token") in previously logged out sessions; for setAuthenticationPhoneNumber only.

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: