Package io.github.natanimn.telebof.types.keyboard

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
Version:
1.4.0
Author:
Natanim
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

    • setRequestUsers

      public KeyboardButton setRequestUsers(KeyboardButtonRequestUsers requestUsers)
      Optional
      Parameters:
      requestUsers - 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

    • setRequestChat

      public KeyboardButton setRequestChat(KeyboardButtonRequestChat requestChat)
      Optional
      Parameters:
      requestChat - 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

    • setRequestContact

      public KeyboardButton setRequestContact(Boolean requestContact)
      Optional
      Parameters:
      requestContact - 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

    • setRequestLocation

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

    • setRequestPoll

      public KeyboardButton setRequestPoll(KeyboardButtonPollType requestPoll)
      Optional
      Parameters:
      requestPoll - Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.
      Returns:
      KeyboardButton

    • setWebApp

      public KeyboardButton setWebApp(WebAppInfo wepApp)
      Optional
      Parameters:
      wepApp - 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

    • setIconCustomEmojiId

      public KeyboardButton setIconCustomEmojiId(String iconCustomEmojiId)
      Optional
      Parameters:
      iconCustomEmojiId - Optional. Unique identifier of the custom emoji shown before the text of the button. Can only be used by bots that purchased additional usernames on Fragment or in the messages directly sent by the bot to private, group and supergroup chats if the owner of the bot has a Telegram Premium subscription.
      Returns:
      KeyboardButton

    • setStyle

      public KeyboardButton setStyle(ButtonStyle style)
      Optional
      Parameters:
      style - Style of the button. If omitted, then an app-specific style is used.
      Returns:
      KeyboardButton