Class LoginUrl

java.lang.Object
io.github.natanimn.telebof.types.keyboard.LoginUrl
All Implemented Interfaces:
Serializable
public class LoginUrl extends Object implements Serializable
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:
Since:
3 March 2025
See Also:

  • Field Details

    • url

      public String url

    • forward_text

      public String forward_text

    • bot_username

      public String bot_username

    • request_write_access

      public Boolean request_write_access

  • Constructor Details

    • LoginUrl

      public LoginUrl(String url)
      Required
      Parameters:
      url - 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.

  • Method Details

    • forwardText

      public LoginUrl forwardText(String forward_text)
      Optional
      Parameters:
      forward_text - New text of the button in forwarded messages.
      Returns:
      LoginUrl

    • botUsername

      public LoginUrl botUsername(String bot_username)
      Optional
      Parameters:
      bot_username - Username of a bot, which will be used for user authorization. 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.
      Returns:
      LoginUrl
      See Also:

    • requestWriteAccess

      public LoginUrl requestWriteAccess(boolean request_write_access)
      Optional
      Parameters:
      request_write_access - Pass True to request the permission for your bot to send messages to the user.
      Returns:
      LoginUrl