pro.zackpollard.telegrambot.api.keyboards

Class ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder

java.lang.Object

pro.zackpollard.telegrambot.api.keyboards.ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder

Enclosing class:

ReplyKeyboardMarkup

public static class ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	addRow(KeyboardButton... buttons) *Optional* Add a new row to the keyboard
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	addRow(List<KeyboardButton> buttons) *Optional* Add a new row to the keyboard
ReplyKeyboardMarkup	build() Builds the ReplyKeyboardMarkup object
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	oneTime(boolean oneTime) *Optional* Requests clients to hide the keyboard as soon as it's been used.
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	resize(boolean resize) *Optional* Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons).
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	selective(boolean selective) *Optional* Use this parameter if you want to show the keyboard to specific users only.
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	setCell(int row, int column, KeyboardButton button) *Optional* Sets a cell of the keyboard
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	setRow(int row, KeyboardButton... buttons) *Optional* Sets a row of the keyboard
ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder	setRow(int row, List<KeyboardButton> buttons) *Optional* Sets a row of the keyboard

Methods inherited from class java.lang.Object

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

Method Detail

addRow

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder addRow(KeyboardButton... buttons)

*Optional* Add a new row to the keyboard

Parameters:

buttons - The buttons for the new row

Returns:

The keyboard builder

addRow

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder addRow(List<KeyboardButton> buttons)

*Optional* Add a new row to the keyboard

Parameters:

buttons - The buttons for the new row

Returns:

The keyboard builder

setRow

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder setRow(int row,
                                                             KeyboardButton... buttons)

*Optional* Sets a row of the keyboard

Parameters:

row - The row you want to set the buttons for

buttons - The buttons for the row

Returns:

The keyboard builder

Throws:

IndexOutOfBoundsException - if the row is out of range

setRow

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder setRow(int row,
                                                             List<KeyboardButton> buttons)

*Optional* Sets a row of the keyboard

Parameters:

row - The index of the row

buttons - The buttons for the row

Returns:

The keyboard builder

Throws:

IndexOutOfBoundsException - if the row is out of range

setCell

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder setCell(int row,
                                                              int column,
                                                              KeyboardButton button)

*Optional* Sets a cell of the keyboard

Parameters:

row - The index of the row

column - The index of the column

button - The value for the cell

Returns:

The keyboard builder

Throws:

IndexOutOfBoundsException - if the row or column is out of range

resize

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder resize(boolean resize)

*Optional* Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard

Parameters:

resize - Whether the client should resize the keyboard

Returns:

The keyboard builder

oneTime

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder oneTime(boolean oneTime)

*Optional* Requests clients to hide the keyboard as soon as it's been used. Defaults to false

Parameters:

oneTime - Whether the keyboard is a one time keyboard

Returns:

The keyboard builder

selective

public ReplyKeyboardMarkup.ReplyKeyboardMarkupBuilder selective(boolean selective)

*Optional* Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message

Parameters:

selective - Whether the keyboard is a selective keyboard

Returns:

The keyboard builder

build

public ReplyKeyboardMarkup build()

Builds the ReplyKeyboardMarkup object

Returns:

A ReplyKeyboardMarkup object based on the previously provided values