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

Inherits Function.

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

Public Fields

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_
 True, if the user allowed the bot to send them messages.
 

Public Types

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

Public Instance Methods

 getLoginUrl ()
 
 getLoginUrl (int53 chat_id_, int53 message_id_, int53 button_id_, bool allow_write_access_)
 
std::int32_t get_id () const final
 
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 = 791844305
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ getLoginUrl() [1/2]

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]

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_True, if the user allowed the bot to send them messages.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

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