Index

B C D E F G H I M O P R T
All Classes and Interfaces|All Packages|Constant Field Values

B

BotCommand - Class in org.telegram.telegrambots.extensions.bots.commandbot.commands

Representation of a command, which can be executed

BotCommand(String, String) - Constructor for class BotCommand

Construct a command

C

COMMAND_INIT_CHARACTER - Static variable in class BotCommand

COMMAND_PARAMETER_SEPARATOR_REGEXP - Static variable in class BotCommand

CommandBot - Interface in org.telegram.telegrambots.extensions.bots.commandbot

This interface represents common functions for command bots

CommandLongPollingTelegramBot - Class in org.telegram.telegrambots.extensions.bots.commandbot

This class adds command functionality to the TelegramLongPollingBot

CommandLongPollingTelegramBot(TelegramClient, boolean, Supplier<String>) - Constructor for class CommandLongPollingTelegramBot

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

CommandMessage - Class in org.telegram.telegrambots.extensions.bots.commandbot

CommandMessage(Message) - Constructor for class CommandMessage

Constructor for CommandMessage

CommandRegistry - Class in org.telegram.telegrambots.extensions.bots.commandbot.commands

This class manages all the commands for a bot.

CommandRegistry(TelegramClient, boolean, Supplier<String>) - Constructor for class CommandRegistry

Creates a Command registry

consume(Update) - Method in class CommandLongPollingTelegramBot

consumeUpdate(Update) - Method in class TelegramWebhookCommandBot

D

DefaultBotCommand - Class in org.telegram.telegrambots.extensions.bots.commandbot.commands

Bot command with message ID in execute method

DefaultBotCommand(String, String) - Constructor for class DefaultBotCommand

Construct a command

deregister(IBotCommand) - Method in class CommandLongPollingTelegramBot

deregister(IBotCommand) - Method in class CommandRegistry

deregister(IBotCommand) - Method in interface ICommandRegistry

deregister a command

deregister(IBotCommand) - Method in class TelegramWebhookCommandBot

deregisterAll(IBotCommand...) - Method in class CommandLongPollingTelegramBot

deregisterAll(IBotCommand...) - Method in class CommandRegistry

deregisterAll(IBotCommand...) - Method in interface ICommandRegistry

deregister multiple commands

deregisterAll(IBotCommand...) - Method in class TelegramWebhookCommandBot

E

execute(TelegramClient, User, Chat, Integer, String[]) - Method in class DefaultBotCommand

Execute the command

execute(TelegramClient, User, Chat, String[]) - Method in class BotCommand

Execute the command

execute(TelegramClient, User, Chat, String[]) - Method in class DefaultBotCommand

execute(TelegramClient, User, Chat, String[]) - Method in class HelpCommand

executeCommand(Message) - Method in class CommandRegistry

Executes a command action if the command is registered.

F

filter(Message) - Method in interface CommandBot

Override this function in your bot implementation to filter messages with commands

G

getArgs() - Method in class CommandMessage

Separates the given text after the command into an ordered array of arguments

getArgsStr() - Method in class CommandMessage

Singles out the text of the message after the command

getCommandIdentifier() - Method in class BotCommand

Get the identifier of this command

getCommandIdentifier() - Method in interface IBotCommand

Get the identifier of this command

getCommandText() - Method in class CommandMessage

getCommandText(boolean) - Method in class CommandMessage

getDescription() - Method in class BotCommand

Get the description of this command

getDescription() - Method in interface IBotCommand

Get the description of this command

getExtendedDescription() - Method in interface IManCommand

Returns the extended Description of this command

getExtendedDescription() - Method in class ManCommand

getHelpText(Collection<IBotCommand>) - Static method in class HelpCommand

Returns the command and description of all supplied commands as a formatted String

getHelpText(IBotCommand...) - Static method in class HelpCommand

Returns the command and description of all supplied commands as a formatted String

getHelpText(ICommandRegistry) - Static method in class HelpCommand

Returns the command and description of all supplied commands as a formatted String

getManText(IManCommand) - Static method in class HelpCommand

Reads the extended Description from a BotCommand;

getManText(IBotCommand) - Static method in class HelpCommand

Reads the extended Description from a BotCommand.

getMessageText() - Method in class CommandMessage

getRegisteredCommand(String) - Method in class CommandLongPollingTelegramBot

getRegisteredCommand(String) - Method in class CommandRegistry

getRegisteredCommand(String) - Method in interface ICommandRegistry

get registered command

getRegisteredCommand(String) - Method in class TelegramWebhookCommandBot

getRegisteredCommands() - Method in class CommandLongPollingTelegramBot

getRegisteredCommands() - Method in class CommandRegistry

getRegisteredCommands() - Method in interface ICommandRegistry

get a collection of all registered commands

getRegisteredCommands() - Method in class TelegramWebhookCommandBot

H

HelpCommand - Class in org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand

A special bot command used for printing help messages similiar to the Linux man command.

HelpCommand() - Constructor for class HelpCommand

Create a Help command with the standard Arguments.

HelpCommand(String, String, String) - Constructor for class HelpCommand

Creates a Help Command with custom identifier, description and extended Description

I

IBotCommand - Interface in org.telegram.telegrambots.extensions.bots.commandbot.commands

This Interface represents the a Command that can be executed

ICommandRegistry - Interface in org.telegram.telegrambots.extensions.bots.commandbot.commands

This Interface represents the gateway for registering and deregistering commands.

IManCommand - Interface in org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand

Represents a Command that, aside the normal command description provides an extended Description similar to the output of the Linux man command

M

ManCommand - Class in org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand

ManCommand(String, String, String) - Constructor for class ManCommand

Create a new ManCommand providing a commandIdentifier, a short description and the extended description

O

org.telegram.telegrambots.extensions.bots.commandbot - package org.telegram.telegrambots.extensions.bots.commandbot

org.telegram.telegrambots.extensions.bots.commandbot.commands - package org.telegram.telegrambots.extensions.bots.commandbot.commands

org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand - package org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand

P

processInvalidCommandUpdate(Update) - Method in interface CommandBot

This method is called when user sends a not registered command.

processMessage(TelegramClient, Message, String[]) - Method in class BotCommand

Process the message and execute the command

processMessage(TelegramClient, Message, String[]) - Method in class DefaultBotCommand

Process the message and execute the command

processMessage(TelegramClient, Message, String[]) - Method in interface IBotCommand

Process the message and execute the command

processNonCommandUpdate(Update) - Method in interface CommandBot

Process all updates, that are not commands.

R

register(IBotCommand) - Method in class CommandLongPollingTelegramBot

register(IBotCommand) - Method in class CommandRegistry

register(IBotCommand) - Method in interface ICommandRegistry

register a command

register(IBotCommand) - Method in class TelegramWebhookCommandBot

registerAll(IBotCommand...) - Method in class CommandLongPollingTelegramBot

registerAll(IBotCommand...) - Method in class CommandRegistry

registerAll(IBotCommand...) - Method in interface ICommandRegistry

register multiple commands

registerAll(IBotCommand...) - Method in class TelegramWebhookCommandBot

registerDefaultAction(BiConsumer<TelegramClient, Message>) - Method in class CommandLongPollingTelegramBot

registerDefaultAction(BiConsumer<TelegramClient, Message>) - Method in class CommandRegistry

registerDefaultAction(BiConsumer<TelegramClient, Message>) - Method in interface ICommandRegistry

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

registerDefaultAction(BiConsumer<TelegramClient, Message>) - Method in class TelegramWebhookCommandBot

T

telegramClient - Variable in class CommandLongPollingTelegramBot

TelegramWebhookCommandBot - Class in org.telegram.telegrambots.extensions.bots.commandbot

This class adds command functionality to the TelegramWebhookBot

TelegramWebhookCommandBot(TelegramClient, boolean, Supplier<String>, String, Runnable, Runnable) - Constructor for class TelegramWebhookCommandBot

Creates a TelegramWebhookCommandBot Use ICommandRegistry's methods on this bot to register commands

toMan() - Method in interface IManCommand

Returns a String Representations of the Command and it's extended Description.

toMan() - Method in class ManCommand

toString() - Method in class BotCommand

B C D E F G H I M O P R T
All Classes and Interfaces|All Packages|Constant Field Values