pro.zackpollard.telegrambot.api.menu

Class InlineMenu

java.lang.Object

pro.zackpollard.telegrambot.api.menu.InlineMenu

public class InlineMenu
extends Object

An inline keyboard represented like a Menu.

Author:

Mazen Kotb

See Also:

builder(TelegramBot), builder(TelegramBot, Chat)

Method Summary

Modifier and Type	Method and Description
void	addRow(InlineMenuRow row)
void	apply() Apply any updates to the message (for viewer on Telegram)
static InlineMenuBuilder	builder(TelegramBot bot) Create a new inline menu builder
static InlineMenuBuilder	builder(TelegramBot bot, Chat forWhom) Creates new builder, initializes with the required Chat field
void	deleteRow(InlineMenuRow row)
void	deleteRowAt(int index)
boolean	handle(CallbackQuery query, int row, int button) Handle an inline query sent.
InlineMenuRow	rowAt(int index) Returns row of specified index
List<InlineMenuRow>	rows()
void	setInternalId(int newId) Set the new internal id.
void	setMessageText(SendableTextMessage.SendableTextMessageBuilder messageBuilder) Set the text of the current message, updates keyboard
void	setRow(int index, InlineMenuRow row)
int	size()
void	start() Starts the inline menu, applies it's keyboard to the menu.
InlineKeyboardMarkup	toKeyboard() Converts rows to the inline keyboard markup used by the Telegram API
void	unregister() Disables listener of the menu.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static InlineMenuBuilder builder(TelegramBot bot)

Create a new inline menu builder

Parameters:

bot - The bot that will be used to send the message for this inline menu

Returns:

new inline menu builder

builder

public static InlineMenuBuilder builder(TelegramBot bot,
                                        Chat forWhom)

Creates new builder, initializes with the required Chat field

Parameters:

bot - The bot that will be used to send the message for this inline menu

forWhom - The chat the inline menu will be sent to

Returns:

new inline menu builder initialized with the forWhom field

rows

public List<InlineMenuRow> rows()

size

public int size()

start

public void start()

Starts the inline menu, applies it's keyboard to the menu. Registers itself as the menu used by the message

See Also:

apply(), InlineMenuRegistry.register(InlineMenu)

unregister

public void unregister()

Disables listener of the menu. Removes from internal cache.

See Also:

InlineMenuRegistry.unregister(InlineMenu)

rowAt

public InlineMenuRow rowAt(int index)

Returns row of specified index

Parameters:

index - Index to get the row at

Returns:

row

Throws:

IndexOutOfBoundsException - if provided out of bounds index

deleteRowAt

public void deleteRowAt(int index)

deleteRow

public void deleteRow(InlineMenuRow row)

addRow

public void addRow(InlineMenuRow row)

setRow

public void setRow(int index,
                   InlineMenuRow row)

toKeyboard

public InlineKeyboardMarkup toKeyboard()

Converts rows to the inline keyboard markup used by the Telegram API

Returns:

keyboard markup

handle

public boolean handle(CallbackQuery query,
                      int row,
                      int button)

Handle an inline query sent. Caller dependent, throws exception if called from a class which doesn't implement InlineMenuRegistry

Parameters:

query - The callback query

row - The button's row

button - The button's column

Returns:

Whether the menu handled the request, if not it was due to a user predicate or invalid row or invalid button

See Also:

InlineMenuRegistry, InlineMenuRow.handle(CallbackQuery, int)

apply

public void apply()

Apply any updates to the message (for viewer on Telegram)

setMessageText

public void setMessageText(SendableTextMessage.SendableTextMessageBuilder messageBuilder)

Set the text of the current message, updates keyboard

Parameters:

messageBuilder - New Message text

See Also:

apply()

setInternalId

public void setInternalId(int newId)

Set the new internal id. Caller dependent, throws exception if called from a class which doesn't implement InlineMenuRegistry

Parameters:

newId - Internal id

See Also:

InlineMenuRegistry