InlineMenus

Allows creation of Inline Menus and bot command handlers

This library depends on https://github.com/rubenlagus/TelegramBots, check it out for more telegram bot implementation details, also https://core.telegram.org/bots/api for telegram bots API details

Maven dependency

<!-- https://mvnrepository.com/artifact/com.github.unafraid.telegram-apis/CoreAPI -->
<dependency>
    <groupId>com.github.unafraid.telegram-apis</groupId>
    <artifactId>CoreAPI</artifactId>
    <version>2.0.0</version>
</dependency>

<!-- https://mvnrepository.com/artifact/com.github.unafraid.telegram-apis/InlineMenuAPI -->
<dependency>
    <groupId>com.github.unafraid.telegram-apis</groupId>
    <artifactId>InlineMenuAPI</artifactId>
    <version>2.0.0</version>
</dependency>

<!-- https://mvnrepository.com/artifact/org.telegram/telegrambots-client -->
<dependency>
    <groupId>org.telegram</groupId>
    <artifactId>telegrambots-client</artifactId>
    <version>7.2.0</version>
</dependency>

Gradle dependency

// https://mvnrepository.com/artifact/com.github.unafraid.telegram-apis/CoreAPI
implementation("com.github.unafraid.telegram-apis:CoreAPI:2.0.0")

// https://mvnrepository.com/artifact/com.github.unafraid.telegram-apis/InlineMenuAPI
implementation("com.github.unafraid.telegram-apis:InlineMenuAPI:2.0.0")

// https://mvnrepository.com/artifact/org.telegram/telegrambots-client
implementation("org.telegram:telegrambots-client:7.2.0")

In order to get started download the library from maven central as jar or maven/gradle dependency manager.

Example

package com.github.unafraid.telegrambot;

import com.github.unafraid.telegrambot.bots.AbstractTelegramBot;
import com.github.unafraid.telegrambot.bots.DefaultTelegramBot;
import com.github.unafraid.telegrambot.handlers.IAccessLevelValidator;
import com.github.unafraid.telegrambot.handlers.ICommandHandler;
import com.github.unafraid.telegrambot.handlers.ITelegramHandler;
import com.github.unafraid.telegrambot.handlers.inline.*;
import com.github.unafraid.telegrambot.handlers.inline.events.InlineCallbackEvent;
import com.github.unafraid.telegrambot.util.BotUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.telegram.telegrambots.client.okhttp.OkHttpTelegramClient;
import org.telegram.telegrambots.longpolling.TelegramBotsLongPollingApplication;
import org.telegram.telegrambots.meta.api.methods.AnswerCallbackQuery;
import org.telegram.telegrambots.meta.api.objects.Update;
import org.telegram.telegrambots.meta.api.objects.User;
import org.telegram.telegrambots.meta.api.objects.message.Message;
import org.telegram.telegrambots.meta.exceptions.TelegramApiException;
import org.telegram.telegrambots.meta.generics.TelegramClient;

import java.util.List;

public class Main {
    private static final String TOKEN = System.getenv("TELEGRAM_BOT_TOKEN");
    private static final Logger LOGGER = LoggerFactory.getLogger(Main.class);

    public static void main(String[] args) throws Exception {
        final TelegramClient telegramClient = new OkHttpTelegramClient(TOKEN);
        final DefaultTelegramBot telegramBot = new DefaultTelegramBot(telegramClient);

        // Create new instance of TelegramBotsAPI
        TelegramBotsLongPollingApplication botsApplication = new TelegramBotsLongPollingApplication();

        // Register the default bot with token and username
        botsApplication.registerBot(TOKEN, telegramBot);

        // Register access level validator
        telegramBot.setAccessLevelValidator(new AccessLevelValidator());

        // Register handlers
        telegramBot.addHandler(new StartCommand());
        telegramBot.addHandler(new ExampleInlineMenu());

        // Register shutdown hook to close bots application
        Runtime.getRuntime().addShutdownHook(new Thread(() -> {
            try {
                botsApplication.close();
            } catch (Exception ex) {
                LOGGER.error("failed to close bots application: ", ex);
            }
        }));
    }

    /**
     * Very simple access level validator class<br />
     * Note: This is just an example implementation, database verification is advised
     */
    static class AccessLevelValidator implements IAccessLevelValidator {
        @Override
        public boolean validate(ITelegramHandler handler, User user) {
            if (handler.getRequiredAccessLevel() == 0) {
                return true;
            }

            // Database validation
            // TODO: Database validation

            // In this example we gonna use required access level 1 to ensure user has set their UserName
            if (handler.getRequiredAccessLevel() == 1 && user.getUserName() != null && !user.getUserName().isEmpty()) {
                return true;
            }

            // Refuse access
            return false;
        }
    }

    /**
     * Very basic command handler accepts command starting with /start
     */
    static class StartCommand implements ICommandHandler {
        @Override
        public String getCommand() {
            return "/start";
        }

        @Override
        public String getUsage() {
            return "/start";
        }

        @Override
        public String getDescription() {
            return "The initial command that you send when you start talking to a bot";
        }

        @Override
        public int getRequiredAccessLevel() {
            return 0;
        }

        @Override
        public void onCommandMessage(AbstractTelegramBot bot, Update update, Message message, List<String> args) throws TelegramApiException {
            final StringBuilder sb = new StringBuilder();
            if (message.getFrom().getUserName() == null || message.getFrom().getUserName().isEmpty()) {
                sb.append("Hello ").append(message.getFrom().getFirstName()).append(", how are ya doin'?").append(System.lineSeparator());
                sb.append("You may want to set an UserName in order to access /menu command").append(System.lineSeparator());
            } else {
                sb.append("Hello @").append(message.getFrom().getUserName()).append(", how are ya doin'?").append(System.lineSeparator());
                sb.append("Type in /menu to see my cool inline menus!");
            }
            BotUtil.sendMessage(bot, message, sb.toString(), true, false, null);
        }
    }

    /**
     * Very basic inline menu handler, accepts command starting with /menu
     */
    static class ExampleInlineMenu extends AbstractInlineHandler {
        @Override
        public String getUsage() {
            return "/menu";
        }

        @Override
        public String getDescription() {
            return "Renders static menu";
        }

        @Override
        public String getCommand() {
            return "/menu";
        }

        @Override
        public int getRequiredAccessLevel() {
            return 1;
        }

        @Override
        public void registerMenu(InlineContext ctx, InlineMenuBuilder builder) {
            //@formatter:off
            builder.name("Main Menu")
                    .button(new InlineButtonBuilder(ctx)
                            .name("Button 1")
                            .onQueryCallback(this::handleButtonClick)
                            .build())
                    .button(new InlineButtonBuilder(ctx)
                            .name("Button 2")
                            .onQueryCallback(this::handleButtonClick)
                            .build())
                    .button(new InlineButtonBuilder(ctx)
                            .name("Button 3")
                            .onQueryCallback(this::handleButtonClick)
                            .build())
                    .button(new InlineButtonBuilder(ctx)
                            .name("Sub menu")
                            .menu(new InlineMenuBuilder(ctx)
                                    .button(new InlineButtonBuilder(ctx)
                                            .name("Sub Button 1")
                                            .onQueryCallback(this::handleButtonClick)
                                            .build())
                                    .button(new InlineButtonBuilder(ctx)
                                            .name("Sub Button 2")
                                            .onQueryCallback(this::handleButtonClick)
                                            .build())
                                    .button(new InlineButtonBuilder(ctx)
                                            .name("Sub Button 3")
                                            .onQueryCallback(this::handleButtonClick)
                                            .build())
                                    .button(defaultBack(ctx))
                                    .build())
                            .build())
                    .button(defaultClose(ctx));
            //@formatter:on
        }

        private boolean handleButtonClick(InlineCallbackEvent event) throws TelegramApiException {
            final InlineUserData userData = event.getContext().getUserData(event.getQuery().getFrom().getId());
            event.getTelegramClient().execute(AnswerCallbackQuery.builder().
                    callbackQueryId(event.getQuery().getId()).
                    showAlert(true).
                    text("You've clicked at " + userData.getActiveButton().getName()).
                    build());
            return true;
        }
    }
}