peyk.platforms.telegram.types.login_url

Classes

LoginUrl([url, forward_text, bot_username, ...])

This object represents a parameter of the inline keyboard button used to automatically authorize a user.

class peyk.platforms.telegram.types.login_url.LoginUrl(url: str = '', forward_text: str | None = None, bot_username: str | None = None, request_write_access: bool | None = None)

Bases: object

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

Variables:

url (str) – 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.

forward_text: New text of the button in forwarded messages bot_username: 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. request_write_access: Pass True to request the permission for your bot to send messages to the user

url: str = ''

forward_text: str | None = None

bot_username: str | None = None

request_write_access: bool | None = None

classmethod from_dict(data: dict | None) → LoginUrl | None

Provides the from dict operation for the Telegram integration.

Parameters:

data – Value used by this operation.

Returns:

Result produced by the operation.

to_dict() → Dict[str, object]

Provides the to dict operation for the Telegram integration.

Returns:

Result produced by the operation.