org.telegram.telegrambots.bots.commandbot.commands

Class BotCommand

java.lang.Object

org.telegram.telegrambots.bots.commandbot.commands.BotCommand

public abstract class BotCommand
extends Object

Representation of a command, which can be executed

Author:

Timo Schulz (Mit0x2)

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMAND_INIT_CHARACTER
static String	COMMAND_PARAMETER_SEPARATOR_REGEXP

Constructor Summary

Constructors

Constructor and Description
BotCommand(String commandIdentifier, String description) Construct a command

Method Summary

Modifier and Type	Method and Description
abstract void	execute(AbsSender absSender, org.telegram.telegrambots.api.objects.User user, org.telegram.telegrambots.api.objects.Chat chat, String[] arguments) Execute the command
String	getCommandIdentifier() Get the identifier of this command
String	getDescription() Get the description of this command
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COMMAND_INIT_CHARACTER

public static final String COMMAND_INIT_CHARACTER

See Also:

Constant Field Values

COMMAND_PARAMETER_SEPARATOR_REGEXP

public static final String COMMAND_PARAMETER_SEPARATOR_REGEXP

See Also:

Constant Field Values

Constructor Detail

BotCommand

public BotCommand(String commandIdentifier,
                  String description)

Construct a command

Parameters:

commandIdentifier - the unique identifier of this command (e.g. the command string to enter into chat)

description - the description of this command

Method Detail

getCommandIdentifier

public final String getCommandIdentifier()

Get the identifier of this command

Returns:

the identifier

getDescription

public final String getDescription()

Get the description of this command

Returns:

the description as String

toString

public String toString()

Overrides:

toString in class Object

execute

public abstract void execute(AbsSender absSender,
                             org.telegram.telegrambots.api.objects.User user,
                             org.telegram.telegrambots.api.objects.Chat chat,
                             String[] arguments)

Execute the command

Parameters:

absSender - absSender to send messages over

user - the user who sent the command

chat - the chat, to be able to send replies

arguments - passed arguments