63 lines
1.8 KiB
Java
63 lines
1.8 KiB
Java
package org.telegram.telegrambots.bots.commands;
|
|
|
|
import org.telegram.telegrambots.api.objects.Message;
|
|
import org.telegram.telegrambots.bots.AbsSender;
|
|
|
|
import java.util.Collection;
|
|
import java.util.Map;
|
|
import java.util.function.BiConsumer;
|
|
|
|
/**
|
|
*
|
|
*/
|
|
public interface ICommandRegistry {
|
|
|
|
/**
|
|
* Register a default action when there is no command register that match the message sent
|
|
* @param defaultConsumer Consumer to evaluate the message
|
|
*
|
|
* @note Use this method if you want your bot to execute a default action when the user
|
|
* sends a command that is not registered.
|
|
*/
|
|
void registerDefaultAction(BiConsumer<AbsSender, Message> defaultConsumer);
|
|
|
|
/**
|
|
* register a command
|
|
*
|
|
* @param botCommand the command to register
|
|
* @return whether the command could be registered, was not already registered
|
|
*/
|
|
boolean register(BotCommand botCommand);
|
|
|
|
/**
|
|
* register multiple commands
|
|
*
|
|
* @param botCommands commands to register
|
|
* @return map with results of the command register per command
|
|
*/
|
|
Map<BotCommand, Boolean> registerAll(BotCommand... botCommands);
|
|
|
|
/**
|
|
* deregister a command
|
|
*
|
|
* @param botCommand the command to deregister
|
|
* @return whether the command could be deregistered, was registered
|
|
*/
|
|
boolean deregister(BotCommand botCommand);
|
|
|
|
/**
|
|
* deregister multiple commands
|
|
*
|
|
* @param botCommands commands to deregister
|
|
* @return map with results of the command deregistered per command
|
|
*/
|
|
Map<BotCommand, Boolean> deregisterAll(BotCommand... botCommands);
|
|
|
|
/**
|
|
* get a collection of all registered commands
|
|
*
|
|
* @return a collection of registered commands
|
|
*/
|
|
Collection<BotCommand> getRegisteredCommands();
|
|
|
|
} |