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

Inherits Function.

Description

Accepts an OAuth authorization request. Returns an HTTP URL to open after successful authorization. May return an empty link if just a toast about successful login has to be shown.

Returns object_ptr<HttpUrl>.

Public Types

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

Public Member Functions

 acceptOauthRequest ()
 acceptOauthRequest (string const &url_, string const &match_code_, bool allow_write_access_, bool allow_phone_number_access_)
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_phone_number_access_
 Pass true if the current user allowed the bot that was returned in getOauthLinkInfo, to access their phone number.
bool allow_write_access_
 Pass true if the current user allowed the bot that was returned in getOauthLinkInfo, to send them messages.
string match_code_
 The matching code chosen by the user.
string url_
 URL of the OAuth deep link.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ acceptOauthRequest() [1/2]

acceptOauthRequest ( )

Default constructor for a function, which accepts an OAuth authorization request. Returns an HTTP URL to open after successful authorization. May return an empty link if just a toast about successful login has to be shown.

Returns object_ptr<HttpUrl>.

◆ acceptOauthRequest() [2/2]

acceptOauthRequest ( string const & url_,
string const & match_code_,
bool allow_write_access_,
bool allow_phone_number_access_ )

Creates a function, which accepts an OAuth authorization request. Returns an HTTP URL to open after successful authorization. May return an empty link if just a toast about successful login has to be shown.

Returns object_ptr<HttpUrl>.

Parameters
[in]url_URL of the OAuth deep link.
[in]match_code_The matching code chosen by the user.
[in]allow_write_access_Pass true if the current user allowed the bot that was returned in getOauthLinkInfo, to send them messages.
[in]allow_phone_number_access_Pass true if the current user allowed the bot that was returned in getOauthLinkInfo, to access 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: