class LoginUrl

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.

Methods

__construct(string $url, string|null $forward_text = null, string|null $bot_username = null, bool|null $request_write_access = null)

No description

string
getUrl()

An HTTPS 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 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 Checking authorization.

string|null
getForwardText()

Optional. New text of the button in forwarded messages.

string|null
getBotUsername()

Optional. Username of a bot, which will be used for user authorization. See 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 Linking your domain to the bot for more details.

bool|null
getRequestWriteAccess()

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

Details

at line 17
__construct(string $url, string|null $forward_text = null, string|null $bot_username = null, bool|null $request_write_access = null)

No description

Parameters

string $url
string|null $forward_text
string|null $bot_username
bool|null $request_write_access

at line 28
string getUrl()

An HTTPS 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 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 Checking authorization.

Return Value

string

at line 36
string|null getForwardText()

Optional. New text of the button in forwarded messages.

Return Value

string|null

at line 44
string|null getBotUsername()

Optional. Username of a bot, which will be used for user authorization. See 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 Linking your domain to the bot for more details.

Return Value

string|null

at line 52
bool|null getRequestWriteAccess()

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

Return Value

bool|null