pro.zackpollard.telegrambot.api.menu.button.impl

Class BackButton

java.lang.Object

pro.zackpollard.telegrambot.api.menu.button.AbstractInlineMenuButton

pro.zackpollard.telegrambot.api.menu.button.impl.BackButton

All Implemented Interfaces:

InlineMenuButton, MenuPressable

public class BackButton
extends AbstractInlineMenuButton

A button which once pressed will exit it's current menu and as a result open the last seen menu. NOTE: Given a menu scenario like this: Menu 1 <-> Menu 2 <-> Menu 3 If the user goes from 1->2->3 then hits the back button on 3, it will take them back to 2. If they hit the back button on 2, it will return them to menu 1. This is to best follow their menu history and not send them to menu 3 when they hit the back button on menu 2 after they've been to menu 3. (what a sentence)

Author:

Mazen Kotb

Field Summary

Fields inherited from class pro.zackpollard.telegrambot.api.menu.button.AbstractInlineMenuButton

buttonCallback, owner, row, text

Constructor Summary

Constructors

Constructor and Description
BackButton(InlineMenu owner, int row)
BackButton(InlineMenu owner, int row, int num) Deprecated.
BackButton(InlineMenu owner, int row, int num, String text) Deprecated.
BackButton(InlineMenu owner, int row, String text)

Method Summary

Modifier and Type	Method and Description
static BackButtonBuilder	builder()
static BackButtonBuilder	builder(String text)
void	handlePress(CallbackQuery query) If there is a last menu, execute callback, unregister the current menu, and start the parent.
InlineKeyboardButton	toKeyboardButton()

Methods inherited from class pro.zackpollard.telegrambot.api.menu.button.AbstractInlineMenuButton

assignMenu, getCallback, getMenu, getNum, getText, keyboardBuilder, setCallback, setText, updateRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface pro.zackpollard.telegrambot.api.menu.button.InlineMenuButton

executeCallback

Constructor Detail

BackButton

@Deprecated
public BackButton(InlineMenu owner,
                              int row,
                              int num)

Deprecated.

BackButton

@Deprecated
public BackButton(InlineMenu owner,
                              int row,
                              int num,
                              String text)

Deprecated.

BackButton

public BackButton(InlineMenu owner,
                  int row)

BackButton

public BackButton(InlineMenu owner,
                  int row,
                  String text)

Method Detail

builder

public static BackButtonBuilder builder()

builder

public static BackButtonBuilder builder(String text)

toKeyboardButton

public InlineKeyboardButton toKeyboardButton()

Returns:

this as an inline keyboard button

handlePress

public void handlePress(CallbackQuery query)

If there is a last menu, execute callback, unregister the current menu, and start the parent.

Parameters:

query - Query to process, unused.

See Also:

InlineMenu.unregister(), InlineMenu.start()