Index
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 org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
-
Construct a command
C
- COMMAND_INIT_CHARACTER - Static variable in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
- COMMAND_PARAMETER_SEPARATOR_REGEXP - Static variable in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
- CommandBot - Interface in org.telegram.telegrambots.extensions.bots.commandbot
-
This interface represents common functions for command bots
- CommandMessage - Class in org.telegram.telegrambots.extensions.bots.commandbot
- CommandMessage(Message) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
-
Constructor for CommandMessage
- CommandRegistry - Class in org.telegram.telegrambots.extensions.bots.commandbot.commands
-
This class manages all the commands for a bot.
- CommandRegistry(boolean, Supplier<String>) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
-
Creates a Command registry
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 org.telegram.telegrambots.extensions.bots.commandbot.commands.DefaultBotCommand
-
Construct a command
- deregister(IBotCommand) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- deregister(IBotCommand) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
deregister a command
- deregister(IBotCommand) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- deregister(IBotCommand) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
- deregisterAll(IBotCommand...) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- deregisterAll(IBotCommand...) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
deregister multiple commands
- deregisterAll(IBotCommand...) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- deregisterAll(IBotCommand...) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
E
- execute(AbsSender, User, Chat, Integer, String[]) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.DefaultBotCommand
-
Execute the command
- execute(AbsSender, User, Chat, String[]) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
-
Execute the command
- execute(AbsSender, User, Chat, String[]) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.DefaultBotCommand
- execute(AbsSender, User, Chat, String[]) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
- executeCommand(AbsSender, Message) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
-
Executes a command action if the command is registered.
F
- filter(Message) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.CommandBot
-
Override this function in your bot implementation to filter messages with commands
- finish() - Method in class org.telegram.telegrambots.extensions.bots.timedbot.TimedSendLongPollingBot
G
- getArgs() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
-
Separates the given text after the command into an ordered array of arguments
- getArgsStr() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
-
Singles out the text of the message after the command
- getBotUsername() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- getCommandIdentifier() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
-
Get the identifier of this command
- getCommandIdentifier() - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.IBotCommand
-
Get the identifier of this command
- getCommandMessage() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
- getCommandText() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
- getCommandText(boolean) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
- getDescription() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
-
Get the description of this command
- getDescription() - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.IBotCommand
-
Get the description of this command
- getExtendedDescription() - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.IManCommand
-
Returns the extended Description of this command
- getExtendedDescription() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.ManCommand
- getHelpText(Collection<IBotCommand>) - Static method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
-
Returns the command and description of all supplied commands as a formatted String
- getHelpText(IBotCommand...) - Static method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
-
Returns the command and description of all supplied commands as a formatted String
- getHelpText(ICommandRegistry) - Static method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
-
Returns the command and description of all supplied commands as a formatted String
- getManText(IManCommand) - Static method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
-
Reads the extended Description from a BotCommand;
- getManText(IBotCommand) - Static method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
-
Reads the extended Description from a BotCommand.
- getMessageText() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.CommandMessage
- getRegisteredCommand(String) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- getRegisteredCommand(String) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
get registered command
- getRegisteredCommand(String) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- getRegisteredCommand(String) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
- getRegisteredCommands() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- getRegisteredCommands() - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
get a collection of all registered commands
- getRegisteredCommands() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- getRegisteredCommands() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.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 org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.HelpCommand
-
Create a Help command with the standard Arguments.
- HelpCommand(String, String, String) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.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 org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.ManCommand
-
Create a new ManCommand providing a commandIdentifier, a short description and the extended description
O
- onUpdateReceived(Update) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- onWebhookUpdateReceived(Update) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
- 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
- org.telegram.telegrambots.extensions.bots.timedbot - package org.telegram.telegrambots.extensions.bots.timedbot
P
- processInvalidCommandUpdate(Update) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.CommandBot
-
This method is called when user sends a not registered command.
- processMessage(AbsSender, Message, String[]) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
-
Process the message and execute the command
- processMessage(AbsSender, Message, String[]) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.DefaultBotCommand
-
Process the message and execute the command
- processMessage(AbsSender, Message, String[]) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.IBotCommand
-
Process the message and execute the command
- processNonCommandUpdate(Update) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.CommandBot
-
Process all updates, that are not commands.
R
- register(IBotCommand) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- register(IBotCommand) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
register a command
- register(IBotCommand) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- register(IBotCommand) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
- registerAll(IBotCommand...) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- registerAll(IBotCommand...) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
register multiple commands
- registerAll(IBotCommand...) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- registerAll(IBotCommand...) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
- registerDefaultAction(BiConsumer<AbsSender, Message>) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.CommandRegistry
- registerDefaultAction(BiConsumer<AbsSender, Message>) - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.ICommandRegistry
-
Register a default action when there is no command register that match the message sent
- registerDefaultAction(BiConsumer<AbsSender, Message>) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
- registerDefaultAction(BiConsumer<AbsSender, Message>) - Method in class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
S
- sendMessageCallback(Long, Object) - Method in class org.telegram.telegrambots.extensions.bots.timedbot.TimedSendLongPollingBot
-
//@Override public void sendMessageCallback(Long chatId, Object messageRequest) { try { if (messageRequest instanceof SendMessage) { sendMessage((SendMessage) messageRequest); } else if (messageRequest instanceof EditMessageText) { editMessageText((EditMessageText) messageRequest); } else if (messageRequest instanceof SendChatAction) { sendChatAction((SendChatAction) messageRequest); } else if (messageRequest instanceof SendDocument) { sendDocument((SendDocument) messageRequest); } //Etc...
- sendTimed(Long, Object) - Method in class org.telegram.telegrambots.extensions.bots.timedbot.TimedSendLongPollingBot
-
SendMessage sendMessageRequest = new SendMessage(); sendMessageRequest.setChatId(chatId); sendMessageRequest.setParseMode("HTML"); sendMessageRequest.setText(text); sendMessageRequest.setReplyMarkup(replyMarkup); sendTimed(chatId, sendMessageRequest); // <-- Instead of sendMessage() API method
T
- TelegramLongPollingCommandBot - Class in org.telegram.telegrambots.extensions.bots.commandbot
-
This class adds command functionality to the TelegramLongPollingBot
- TelegramLongPollingCommandBot() - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
-
Creates a TelegramLongPollingCommandBot using default options Use ICommandRegistry's methods on this bot to register commands
- TelegramLongPollingCommandBot(DefaultBotOptions) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
-
Creates a TelegramLongPollingCommandBot with custom options and allowing commands with usernames Use ICommandRegistry's methods on this bot to register commands
- TelegramLongPollingCommandBot(DefaultBotOptions, boolean) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.TelegramLongPollingCommandBot
-
Creates a TelegramLongPollingCommandBot Use ICommandRegistry's methods on this bot to register commands
- TelegramWebhookCommandBot - Class in org.telegram.telegrambots.extensions.bots.commandbot
-
This class adds command functionality to the TelegramWebhookBot
- TelegramWebhookCommandBot() - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
-
Creates a TelegramWebhookCommandBot using default options Use ICommandRegistry's methods on this bot to register commands
- TelegramWebhookCommandBot(DefaultBotOptions) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
-
Creates a TelegramWebhookCommandBot with custom options and allowing commands with usernames Use ICommandRegistry's methods on this bot to register commands
- TelegramWebhookCommandBot(DefaultBotOptions, boolean) - Constructor for class org.telegram.telegrambots.extensions.bots.commandbot.TelegramWebhookCommandBot
-
Creates a TelegramWebhookCommandBot Use ICommandRegistry's methods on this bot to register commands
- TimedSendLongPollingBot - Class in org.telegram.telegrambots.extensions.bots.timedbot
-
Created by Daniil Nikanov aka JetCoder
- TimedSendLongPollingBot() - Constructor for class org.telegram.telegrambots.extensions.bots.timedbot.TimedSendLongPollingBot
- toMan() - Method in interface org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.IManCommand
-
Returns a String Representations of the Command and it's extended Description.
- toMan() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.helpCommand.ManCommand
- toString() - Method in class org.telegram.telegrambots.extensions.bots.commandbot.commands.BotCommand
All Classes and Interfaces|All Packages|Constant Field Values