List of all members | Public Fields | Public Instance Methods | Static Public Attributes
oauthLinkInfo Class Referencefinal

Inherits Object.

Description

Information about the OAuth authorization.

Public Fields

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 app, 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.
 
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.
 

Public Instance Methods

 oauthLinkInfo ()
 
 oauthLinkInfo (int53 user_id_, string const &url_, string const &domain_, 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 Instance Methods inherited from 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
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ oauthLinkInfo() [1/2]

Information about the OAuth authorization.

◆ oauthLinkInfo() [2/2]

oauthLinkInfo ( int53  user_id_,
string const &  url_,
string const &  domain_,
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 app, 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]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.

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