Package org.telegram.telegrambots.extensions.bots.commandbot

Class CommandLongPollingTelegramBot

Object

CommandLongPollingTelegramBot

All Implemented Interfaces:

CommandBot, ICommandRegistry, LongPollingUpdateConsumer, LongPollingSingleThreadUpdateConsumer

public abstract class CommandLongPollingTelegramBot
extends Object
implements CommandBot, ICommandRegistry, LongPollingSingleThreadUpdateConsumer

This class adds command functionality to the TelegramLongPollingBot

Author:

Timo Schulz (Mit0x2)

Field Summary

Fields

Modifier and Type	Field	Description
protected final TelegramClient	telegramClient

Fields inherited from interface LongPollingSingleThreadUpdateConsumer

updatesProcessorExecutor

Constructor Summary

Constructors

Constructor	Description
CommandLongPollingTelegramBot(TelegramClient telegramClient, boolean allowCommandsWithUsername, Supplier<String> botUsernameSupplier)	Creates a Bot for Long Polling Use ICommandRegistry's methods on this bot to register commands

Method Summary

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

Methods inherited from class Object

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

Methods inherited from interface CommandBot

filter, processInvalidCommandUpdate, processNonCommandUpdate

Methods inherited from interface LongPollingSingleThreadUpdateConsumer

consume

Field Details

telegramClient

protected final TelegramClient telegramClient

Constructor Details

CommandLongPollingTelegramBot

public CommandLongPollingTelegramBot(TelegramClient telegramClient,
 boolean allowCommandsWithUsername,
 Supplier<String> botUsernameSupplier)

Creates a Bot for Long Polling Use ICommandRegistry's methods on this bot to register commands

Parameters:

telegramClient - Telegram client used to send requests

allowCommandsWithUsername - true to allow commands with parameters (default), false otherwise

botUsernameSupplier - Bot username supplier

Method Details

consume

public final void consume(Update update)

Specified by:

consume in interface LongPollingSingleThreadUpdateConsumer

register

public final boolean register(IBotCommand botCommand)

Description copied from interface: ICommandRegistry

register a command

Specified by:

register in interface ICommandRegistry

Parameters:

botCommand - the command to register

Returns:

whether the command could be registered, was not already registered

registerAll

public final Map<IBotCommand,Boolean> registerAll(IBotCommand... botCommands)

Description copied from interface: ICommandRegistry

register multiple commands

Specified by:

registerAll in interface ICommandRegistry

Parameters:

botCommands - commands to register

Returns:

map with results of the command register per command

deregister

public final boolean deregister(IBotCommand botCommand)

Description copied from interface: ICommandRegistry

deregister a command

Specified by:

deregister in interface ICommandRegistry

Parameters:

botCommand - the command to deregister

Returns:

whether the command could be deregistered, was registered

deregisterAll

public final Map<IBotCommand,Boolean> deregisterAll(IBotCommand... botCommands)

Description copied from interface: ICommandRegistry

deregister multiple commands

Specified by:

deregisterAll in interface ICommandRegistry

Parameters:

botCommands - commands to deregister

Returns:

map with results of the command deregistered per command

getRegisteredCommands

public final Collection<IBotCommand> getRegisteredCommands()

Description copied from interface: ICommandRegistry

get a collection of all registered commands

Specified by:

getRegisteredCommands in interface ICommandRegistry

Returns:

a collection of registered commands

registerDefaultAction

public void registerDefaultAction(BiConsumer<TelegramClient,Message> defaultConsumer)

Description copied from interface: ICommandRegistry

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

Specified by:

registerDefaultAction in interface ICommandRegistry

Parameters:

defaultConsumer - Consumer to evaluate the message

getRegisteredCommand

public final IBotCommand getRegisteredCommand(String commandIdentifier)

Description copied from interface: ICommandRegistry

get registered command

Specified by:

getRegisteredCommand in interface ICommandRegistry

Returns:

registered command if exists or null if not