org.telegram.telegrambots.bots.commands

Interface ICommandRegistry

All Known Implementing Classes:

CommandRegistry, TelegramLongPollingCommandBot

public interface ICommandRegistry

This Interface represents the gateway for registering and deregistering commands.

Author:

Timo Schulz (Mit0x2)

Method Summary

Modifier and Type	Method and Description
boolean	deregister(BotCommand botCommand) deregister a command
Map<BotCommand,Boolean>	deregisterAll(BotCommand... botCommands) deregister multiple commands
BotCommand	getRegisteredCommand(String commandIdentifier) get registered command
Collection<BotCommand>	getRegisteredCommands() get a collection of all registered commands
boolean	register(BotCommand botCommand) register a command
Map<BotCommand,Boolean>	registerAll(BotCommand... botCommands) register multiple commands
void	registerDefaultAction(BiConsumer<AbsSender,Message> defaultConsumer) Register a default action when there is no command register that match the message sent

Method Detail

registerDefaultAction

void registerDefaultAction(BiConsumer<AbsSender,Message> defaultConsumer)

Register a default action when there is no command register that match the message sent

Parameters:

defaultConsumer - Consumer to evaluate the message

register

boolean register(BotCommand botCommand)

register a command

Parameters:

botCommand - the command to register

Returns:

whether the command could be registered, was not already registered

registerAll

Map<BotCommand,Boolean> registerAll(BotCommand... botCommands)

register multiple commands

Parameters:

botCommands - commands to register

Returns:

map with results of the command register per command

deregister

boolean deregister(BotCommand botCommand)

deregister a command

Parameters:

botCommand - the command to deregister

Returns:

whether the command could be deregistered, was registered

deregisterAll

Map<BotCommand,Boolean> deregisterAll(BotCommand... botCommands)

deregister multiple commands

Parameters:

botCommands - commands to deregister

Returns:

map with results of the command deregistered per command

getRegisteredCommands

Collection<BotCommand> getRegisteredCommands()

get a collection of all registered commands

Returns:

a collection of registered commands

getRegisteredCommand

BotCommand getRegisteredCommand(String commandIdentifier)

get registered command

Returns:

registered command if exists or null if not