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

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

Inheritance diagram for td::td_api::oauthLinkInfo:
td::td_api::Object td::TlObject

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 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

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 url_
 An HTTP URL where the user authorizes.
 
string domain_
 A domain of the URL.
 
bool from_app_
 True, if the authorization originates from an application.
 
string verified_app_name_
 Verified name of the application; if empty, then "Unverified App" must be shown instead.
 
int53 bot_user_id_
 User identifier of a bot linked with the website.
 
bool request_write_access_
 True, if the user must be asked for the permission to the bot to send them messages.
 
bool request_phone_number_access_
 True, if the user must be asked for the permission to share their phone number.
 
string browser_
 The version of a browser used for the authorization.
 
string platform_
 Operating system the browser is running on.
 
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< stringmatch_codes_
 The list of codes to match; may be empty if irrelevant.
 

Static Public Attributes

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

Detailed Description

Information about the OAuth authorization.

Definition at line 47000 of file td_api.h.

Constructor & Destructor Documentation

◆ oauthLinkInfo() [1/2]

td::td_api::oauthLinkInfo::oauthLinkInfo ( )

Information about the OAuth authorization.

◆ oauthLinkInfo() [2/2]

td::td_api::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_ 
)

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 td::td_api::oauthLinkInfo::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

◆ bot_user_id_

int53 td::td_api::oauthLinkInfo::bot_user_id_

User identifier of a bot linked with the website.

Definition at line 47021 of file td_api.h.

◆ browser_

string td::td_api::oauthLinkInfo::browser_

The version of a browser used for the authorization.

Definition at line 47027 of file td_api.h.

◆ domain_

string td::td_api::oauthLinkInfo::domain_

A domain of the URL.

Definition at line 47015 of file td_api.h.

◆ from_app_

bool td::td_api::oauthLinkInfo::from_app_

True, if the authorization originates from an application.

Definition at line 47017 of file td_api.h.

◆ ID

const std::int32_t td::td_api::oauthLinkInfo::ID = -908945202
static

Identifier uniquely determining a type of the object.

Definition at line 47065 of file td_api.h.

◆ ip_address_

string td::td_api::oauthLinkInfo::ip_address_

IP address from which the authorization is performed, in human-readable format.

Definition at line 47031 of file td_api.h.

◆ location_

string td::td_api::oauthLinkInfo::location_

Human-readable description of a country and a region from which the authorization is performed, based on the IP address.

Definition at line 47033 of file td_api.h.

◆ match_code_first_

bool td::td_api::oauthLinkInfo::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.

Definition at line 47035 of file td_api.h.

◆ match_codes_

array<string> td::td_api::oauthLinkInfo::match_codes_

The list of codes to match; may be empty if irrelevant.

Definition at line 47037 of file td_api.h.

◆ platform_

string td::td_api::oauthLinkInfo::platform_

Operating system the browser is running on.

Definition at line 47029 of file td_api.h.

◆ request_phone_number_access_

bool td::td_api::oauthLinkInfo::request_phone_number_access_

True, if the user must be asked for the permission to share their phone number.

Definition at line 47025 of file td_api.h.

◆ request_write_access_

bool td::td_api::oauthLinkInfo::request_write_access_

True, if the user must be asked for the permission to the bot to send them messages.

Definition at line 47023 of file td_api.h.

◆ url_

string td::td_api::oauthLinkInfo::url_

An HTTP URL where the user authorizes.

Definition at line 47013 of file td_api.h.

◆ user_id_

int53 td::td_api::oauthLinkInfo::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.

Definition at line 47011 of file td_api.h.

◆ verified_app_name_

string td::td_api::oauthLinkInfo::verified_app_name_

Verified name of the application; if empty, then "Unverified App" must be shown instead.

Definition at line 47019 of file td_api.h.


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