getLoginUrl Class Reference

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 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 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_write_access_
	Pass true to allow the bot to send messages to the current user. Phone number access can't be requested using the button.
int53	button_id_
	Button identifier.
int53	chat_id_
	Chat identifier of the message with the button.
int53	message_id_
	Message identifier of the message with the button.

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

Constructor & Destructor Documentation

getLoginUrl() [1/2]

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]

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't be requested using the button.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h