Class KeyboardButton

java.lang.Object
io.github.natanimn.telebof.types.keyboard.KeyboardButton
All Implemented Interfaces:
Serializable
public class KeyboardButton extends Object implements Serializable
This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text.
Since:
3 March 2025
See Also:

  • Constructor Details

    • KeyboardButton

      public KeyboardButton(String text)
      Required
      Parameters:
      text - Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed

  • Method Details

    • requestUser

      public KeyboardButton requestUser(KeyboardButtonRequestUsers request_users)
      Optional
      Parameters:
      request_users - If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a “users_shared” service message. Available in private chats only.
      Returns:
      KeyboardButton

    • requestChat

      public KeyboardButton requestChat(KeyboardButtonRequestChat request_chat)
      Optional
      Parameters:
      request_chat - If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a “chat_shared” service message. Available in private chats only.
      Returns:
      KeyboardButton

    • requestContact

      public KeyboardButton requestContact(boolean request_contact)
      Optional
      Parameters:
      request_contact - If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
      Returns:
      KeyboardButton

    • requestLocation

      public KeyboardButton requestLocation(boolean request_location)
      Optional
      Parameters:
      request_location - If True, the user's current location will be sent when the button is pressed. Available in private chats only.
      Returns:
      KeyboardButton

    • requestPoll

      public KeyboardButton requestPoll(KeyboardButtonPollType request_poll)
      Optional
      Parameters:
      request_poll -
      Returns:
      KeyboardButton

    • webApp

      public KeyboardButton webApp(WebAppInfo wep_app)
      Optional
      Parameters:
      wep_app - If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
      Returns:
      KeyboardButton