pro.zackpollard.telegrambot.api.keyboards

Class InlineKeyboardButton.InlineKeyboardButtonBuilder

java.lang.Object

pro.zackpollard.telegrambot.api.keyboards.InlineKeyboardButton.InlineKeyboardButtonBuilder

Enclosing class:

InlineKeyboardButton

public static class InlineKeyboardButton.InlineKeyboardButtonBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
InlineKeyboardButton	build() Builds the InlineKeyboardButton object
InlineKeyboardButton.InlineKeyboardButtonBuilder	callbackData(String callbackData) *Optional* Sets the data to be sent in a callback query to the bot when button is pressed, 1-64 bytes
InlineKeyboardButton.InlineKeyboardButtonBuilder	callbackGame(CallbackGame callbackGame) *Optional* Sets the CallbackGame object that will be sent with this button.
InlineKeyboardButton.InlineKeyboardButtonBuilder	switchInlineQuery(String switchInlineQuery) *Optional* Sets the inline query switch text.
InlineKeyboardButton.InlineKeyboardButtonBuilder	switchInlineQueryCurrentChat(String switchInlineQueryCurrentChat) *Optional* If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field.
InlineKeyboardButton.InlineKeyboardButtonBuilder	text(String text) *Required* Sets the text that will be displayed on this button
InlineKeyboardButton.InlineKeyboardButtonBuilder	url(String url) *Optional* Sets the HTTP url to be opened when button is pressed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

text

public InlineKeyboardButton.InlineKeyboardButtonBuilder text(String text)

*Required* Sets the text that will be displayed on this button

Parameters:

text - The text that will be displayed on this button

Returns:

The builder object

url

public InlineKeyboardButton.InlineKeyboardButtonBuilder url(String url)

*Optional* Sets the HTTP url to be opened when button is pressed

Parameters:

url - The HTTP url to be opened when button is pressed

Returns:

The builder object

callbackData

public InlineKeyboardButton.InlineKeyboardButtonBuilder callbackData(String callbackData)

*Optional* Sets the data to be sent in a callback query to the bot when button is pressed, 1-64 bytes

Parameters:

callbackData - The data to be sent in a callbackquery to the bot when button is pressed, 1-64 bytes

Returns:

The builder object

switchInlineQuery

public InlineKeyboardButton.InlineKeyboardButtonBuilder switchInlineQuery(String switchInlineQuery)

*Optional* Sets the inline query switch text. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.

Parameters:

switchInlineQuery - The inline query switch text

Returns:

The builder object

switchInlineQueryCurrentChat

public InlineKeyboardButton.InlineKeyboardButtonBuilder switchInlineQueryCurrentChat(String switchInlineQueryCurrentChat)

*Optional* If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot’s username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat – good for selecting something from multiple options.

Parameters:

switchInlineQueryCurrentChat - The parameters you want to be added after the bots username in the inline query. Can be an empty string if you only want the bots username to be inserted.

Returns:

The builder object

callbackGame

public InlineKeyboardButton.InlineKeyboardButtonBuilder callbackGame(CallbackGame callbackGame)

*Optional* Sets the CallbackGame object that will be sent with this button. NOTE: This will currently do nothing as this is just placeholder for when telegram implements the CallbackGame object

Parameters:

callbackGame - The inline query switch text

Returns:

The builder object

build

public InlineKeyboardButton build()

Builds the InlineKeyboardButton object

Returns:

A InlineKeyboardButton object based on the previously provided values