Package org.telegram.abilitybots.api.bot

Class BaseAbilityBot

java.lang.Object

org.telegram.telegrambots.meta.bots.AbsSender

org.telegram.telegrambots.bots.DefaultAbsSender

org.telegram.abilitybots.api.bot.BaseAbilityBot

All Implemented Interfaces:

AbilityExtension

Direct Known Subclasses:

AbilityBot, AbilityWebhookBot

public abstract class BaseAbilityBot
extends DefaultAbsSender
implements AbilityExtension

The father of all ability bots. Bots that need to utilize abilities need to extend this bot.

It's important to note that this bot strictly extends TelegramLongPollingBot.

All bots extending the BaseAbilityBot get implicit abilities:

• /claim - Claims this bot
• Sets the user as the Privacy.CREATOR of the bot
• Only the user with the ID returned by creatorId() can genuinely claim the bot
• /report - reports all user-defined commands (abilities)
• The same format acceptable by BotFather
• /commands - returns a list of all possible bot commands based on the privacy of the requesting user
• /backup - returns a backup of the bot database
• /recover - recovers the database
• /promote @username - promotes user to bot admin
• /demote @username - demotes bot admin to user
• /ban @username - bans the user from accessing your bot commands and features
• /unban @username - lifts the ban from the user

Additional information of the implicit abilities are present in the methods that declare them.

The two most important handles in the BaseAbilityBot are the DBContext db and the MessageSender sender. All bots extending BaseAbilityBot can use both handles in their update consumers.

Author:

Abbas Abou Daya

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADMINS
static String	BLACKLIST
protected DBContext	db
protected static String	DEFAULT
protected MessageSender	sender
protected SilentSender	silent
static String	USER_ID
static String	USERS

Fields inherited from class org.telegram.telegrambots.bots.DefaultAbsSender

exe

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseAbilityBot(String botToken, String botUsername, DBContext db, AbilityToggle toggle, DefaultBotOptions botOptions)

Method Summary

Modifier and Type	Method	Description
Map<String,Ability>	abilities()
protected Set<Integer>	admins()
protected Set<Integer>	blacklist()
protected boolean	checkGlobalFlags(org.telegram.telegrambots.meta.api.objects.Update update)	Test the update against the provided global flags.
abstract int	creatorId()
String	getBotToken()
String	getBotUsername()
void	onUpdateReceived(org.telegram.telegrambots.meta.api.objects.Update update)	This method contains the stream of actions that are applied on any update.
List<Reply>	replies()
protected Map<String,Integer>	userIds()
protected Map<Integer,org.telegram.telegrambots.meta.api.objects.User>	users()

Methods inherited from class org.telegram.telegrambots.bots.DefaultAbsSender

downloadFile, downloadFile, downloadFile, downloadFile, downloadFileAsStream, downloadFileAsStream, downloadFileAsync, downloadFileAsync, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, execute, getBaseUrl, getOptions, sendApiMethod, sendApiMethodAsync

Methods inherited from class org.telegram.telegrambots.meta.bots.AbsSender

execute, executeAsync, getMe, getMeAsync, getWebhookInfo, getWebhookInfoAsync

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

protected static final String DEFAULT

See Also:

Constant Field Values

ADMINS

public static final String ADMINS

See Also:

Constant Field Values

USERS

public static final String USERS

See Also:

Constant Field Values

USER_ID

public static final String USER_ID

See Also:

Constant Field Values

BLACKLIST

public static final String BLACKLIST

See Also:

Constant Field Values

db

protected final DBContext db

sender

protected MessageSender sender

silent

protected SilentSender silent

Constructor Detail

BaseAbilityBot

protected BaseAbilityBot(String botToken,
                         String botUsername,
                         DBContext db,
                         AbilityToggle toggle,
                         DefaultBotOptions botOptions)

Method Detail

creatorId

public abstract int creatorId()

users

protected Map<Integer,org.telegram.telegrambots.meta.api.objects.User> users()

Returns:

the map of

userIds

protected Map<String,Integer> userIds()

Returns:

the map of

blacklist

protected Set<Integer> blacklist()

Returns:

a blacklist containing all the IDs of the banned users

admins

protected Set<Integer> admins()

Returns:

an admin set of all the IDs of bot administrators

abilities

public Map<String,Ability> abilities()

Returns:

the immutable map of

replies

public List<Reply> replies()

Returns:

the immutable list carrying the embedded replies

onUpdateReceived

public void onUpdateReceived(org.telegram.telegrambots.meta.api.objects.Update update)

This method contains the stream of actions that are applied on any update.

It will correctly handle addition of users into the DB and the execution of abilities and replies.

Parameters:

update - the update received by Telegram's API

getBotToken

public String getBotToken()

Specified by:

getBotToken in class DefaultAbsSender

getBotUsername

public String getBotUsername()

checkGlobalFlags

protected boolean checkGlobalFlags(org.telegram.telegrambots.meta.api.objects.Update update)

Test the update against the provided global flags. The default implementation is a passthrough to all updates.

This method should be overridden if the user wants to restrict bot usage to only certain updates.

Parameters:

update - a Telegram Update

Returns:

true if the update satisfies the global flags