This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in. Telegram apps support these buttons as of version 5.7. More...

#include <LoginUrl.h>

Public Types
typedef std::shared_ptr< LoginUrl >	Ptr

Public Attributes
std::string	url
	An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in https://core.telegram.org/widgets/login#receiving-authorization-data.

std::string	forwardText
	Optional. New text of the button in forwarded messages.

std::string	botUsername
	Optional. Username of a bot, which will be used for user authorization. See https://core.telegram.org/widgets/login#setting-up-a-bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot for more details.

bool	requestWriteAccess
	Optional. Pass True to request the permission for your bot to send messages to the user.

Detailed Description

This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in. Telegram apps support these buttons as of version 5.7.

Sample bot: @discussbot

Definition at line 19 of file LoginUrl.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<LoginUrl> TgBot::LoginUrl::Ptr

Definition at line 21 of file LoginUrl.h.

Member Data Documentation

◆ botUsername

std::string TgBot::LoginUrl::botUsername

Optional. Username of a bot, which will be used for user authorization. See https://core.telegram.org/widgets/login#setting-up-a-bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See https://core.telegram.org/widgets/login#linking-your-domain-to-the-bot for more details.

Definition at line 44 of file LoginUrl.h.

◆ forwardText

std::string TgBot::LoginUrl::forwardText

Optional. New text of the button in forwarded messages.

Definition at line 35 of file LoginUrl.h.

◆ requestWriteAccess

bool TgBot::LoginUrl::requestWriteAccess

Optional. Pass True to request the permission for your bot to send messages to the user.

Definition at line 49 of file LoginUrl.h.

◆ url

std::string TgBot::LoginUrl::url

An HTTP URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in https://core.telegram.org/widgets/login#receiving-authorization-data.

NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in https://core.telegram.org/widgets/login#checking-authorization

Definition at line 30 of file LoginUrl.h.

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

include/tgbot/types/LoginUrl.h

Public Types

Public Attributes