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

Inherits Object.

Description

Information about the OAuth authorization.

Public Member Functions

 oauthLinkInfo ()
 oauthLinkInfo (int53 user_id_, string const &url_, string const &domain_, bool from_app_, string const &verified_app_name_, int53 bot_user_id_, bool request_write_access_, bool request_phone_number_access_, string const &browser_, string const &platform_, string const &ip_address_, string const &location_, bool match_code_first_, array< string > &&match_codes_)
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

int53 bot_user_id_
 User identifier of a bot linked with the website.
string browser_
 The version of a browser used for the authorization.
string domain_
 A domain of the URL.
bool from_app_
 True, if the authorization originates from an application.
string ip_address_
 IP address from which the authorization is performed, in human-readable format.
string location_
 Human-readable description of a country and a region from which the authorization is performed, based on the IP address.
bool match_code_first_
 True, if code matching dialog must be shown first and checkOauthRequestMatchCode must be called before acceptOauthRequest. Otherwise, checkOauthRequestMatchCode must not be called.
array< string > match_codes_
 The list of codes to match; may be empty if irrelevant.
string platform_
 Operating system the browser is running on.
bool request_phone_number_access_
 True, if the user must be asked for the permission to share their phone number.
bool request_write_access_
 True, if the user must be asked for the permission to the bot to send them messages.
string url_
 An HTTP URL where the user authorizes.
int53 user_id_
 Identifier of the user for which the link was generated; may be 0 if unknown. The corresponding user may be unknown. If the user is logged in the application, then they must be chosen for authorization by default.
string verified_app_name_
 Verified name of the application; if empty, then "Unverified App" must be shown instead.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ oauthLinkInfo() [1/2]

oauthLinkInfo ( )

Information about the OAuth authorization.

◆ oauthLinkInfo() [2/2]

oauthLinkInfo ( int53 user_id_,
string const & url_,
string const & domain_,
bool from_app_,
string const & verified_app_name_,
int53 bot_user_id_,
bool request_write_access_,
bool request_phone_number_access_,
string const & browser_,
string const & platform_,
string const & ip_address_,
string const & location_,
bool match_code_first_,
array< string > && match_codes_ )

Information about the OAuth authorization.

Parameters
[in]user_id_Identifier of the user for which the link was generated; may be 0 if unknown. The corresponding user may be unknown. If the user is logged in the application, then they must be chosen for authorization by default.
[in]url_An HTTP URL where the user authorizes.
[in]domain_A domain of the URL.
[in]from_app_True, if the authorization originates from an application.
[in]verified_app_name_Verified name of the application; if empty, then "Unverified App" must be shown instead.
[in]bot_user_id_User identifier of a bot linked with the website.
[in]request_write_access_True, if the user must be asked for the permission to the bot to send them messages.
[in]request_phone_number_access_True, if the user must be asked for the permission to share their phone number.
[in]browser_The version of a browser used for the authorization.
[in]platform_Operating system the browser is running on.
[in]ip_address_IP address from which the authorization is performed, in human-readable format.
[in]location_Human-readable description of a country and a region from which the authorization is performed, based on the IP address.
[in]match_code_first_True, if code matching dialog must be shown first and checkOauthRequestMatchCode must be called before acceptOauthRequest. Otherwise, checkOauthRequestMatchCode must not be called.
[in]match_codes_The list of codes to match; may be empty if irrelevant.

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: