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

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

Inheritance diagram for td::td_api::getLoginUrl:
td::td_api::Function td::TlObject

Public Types

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

Public Member Functions

 getLoginUrl ()
 
 getLoginUrl (int53 chat_id_, int53 message_id_, int53 button_id_, bool allow_write_access_)
 
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 chat_id_
 Chat identifier of the message with the button.
 
int53 message_id_
 Message identifier of the message with the button.
 
int53 button_id_
 Button identifier.
 
bool allow_write_access_
 Pass true to allow the bot to send messages to the current user. Phone number access can&#x27;t be requested using the button.
 

Static Public Attributes

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

Detailed Description

Returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button.

Returns object_ptr<HttpUrl>.

Definition at line 108308 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 108350 of file td_api.h.

Constructor & Destructor Documentation

◆ getLoginUrl() [1/2]

td::td_api::getLoginUrl::getLoginUrl ( )

Default constructor for a function, which returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button.

Returns object_ptr<HttpUrl>.

◆ getLoginUrl() [2/2]

td::td_api::getLoginUrl::getLoginUrl ( int53  chat_id_,
int53  message_id_,
int53  button_id_,
bool  allow_write_access_ 
)

Creates a function, which returns an HTTP URL which can be used to automatically authorize the user on a website after clicking an inline button of type inlineKeyboardButtonTypeLoginUrl. Use the method getLoginUrlInfo to find whether a prior user confirmation is needed. If an error is returned, then the button must be handled as an ordinary URL button.

Returns object_ptr<HttpUrl>.

Parameters
[in]chat_id_Chat identifier of the message with the button.
[in]message_id_Message identifier of the message with the button.
[in]button_id_Button identifier.
[in]allow_write_access_Pass true to allow the bot to send messages to the current user. Phone number access can&#x27;t be requested using the button.

Member Function Documentation

◆ store()

void td::td_api::getLoginUrl::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

◆ allow_write_access_

bool td::td_api::getLoginUrl::allow_write_access_

Pass true to allow the bot to send messages to the current user. Phone number access can&#x27;t be requested using the button.

Definition at line 108325 of file td_api.h.

◆ button_id_

int53 td::td_api::getLoginUrl::button_id_

Button identifier.

Definition at line 108323 of file td_api.h.

◆ chat_id_

int53 td::td_api::getLoginUrl::chat_id_

Chat identifier of the message with the button.

Definition at line 108319 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getLoginUrl::ID = 791844305
static

Identifier uniquely determining a type of the object.

Definition at line 108347 of file td_api.h.

◆ message_id_

int53 td::td_api::getLoginUrl::message_id_

Message identifier of the message with the button.

Definition at line 108321 of file td_api.h.


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