Package org.telegram.telegrambots.abilitybots.api.bot

Class BaseAbilityBot

Object

BaseAbilityBot

All Implemented Interfaces:

AbilityExtension, LongPollingUpdateConsumer, LongPollingSingleThreadUpdateConsumer

Direct Known Subclasses:

AbilityBot, AbilityWebhookBot

public abstract class BaseAbilityBot
extends Object
implements AbilityExtension, LongPollingSingleThreadUpdateConsumer

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 implements LongPollingSingleThreadUpdateConsumer.

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 TelegramClient 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 final String	ADMINS
static final String	BLACKLIST
protected final DBContext	db
protected static final String	DEFAULT
protected SilentSender	silent
static final String	STATS
protected TelegramClient	telegramClient
static final String	USER_ID
static final String	USERS

Fields inherited from interface LongPollingSingleThreadUpdateConsumer

updatesProcessorExecutor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseAbilityBot(TelegramClient telegramClient, String botUsername, DBContext db, AbilityToggle toggle)

Method Summary

Modifier and Type	Method	Description
protected void	addExtension(AbilityExtension extension)
protected void	addExtensions(Collection<AbilityExtension> extensions)
protected void	addExtensions(AbilityExtension... extensions)
Set<Long>	admins()
protected boolean	allowContinuousText()
Set<Long>	blacklist()
protected boolean	checkGlobalFlags(Update update)	Test the update against the provided global flags.
void	consume(Update update)	This method contains the stream of actions that are applied on any update.
abstract long	creatorId()
protected String	getCommandPrefix()
protected String	getCommandRegexSplit()
Privacy	getPrivacy(Update update, long id)
boolean	isAdmin(long id)
boolean	isCreator(long id)
boolean	isGroupAdmin(long chatId, long id)
boolean	isGroupAdmin(Update update, long id)
void	onRegister()
Map<String,Long>	userIds()
Map<Long,User>	users()

Methods inherited from class Object

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

Methods inherited from interface LongPollingSingleThreadUpdateConsumer

consume

Field Details

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

STATS

public static final String STATS

See Also:

• Constant Field Values

db

protected final DBContext db

telegramClient

protected TelegramClient telegramClient

silent

protected SilentSender silent

Constructor Details

BaseAbilityBot

protected BaseAbilityBot(TelegramClient telegramClient,
 String botUsername,
 DBContext db,
 AbilityToggle toggle)

Method Details

creatorId

public abstract long creatorId()

onRegister

public void onRegister()

users

public Map<Long,User> users()

Returns:

the map of <ID,User>

userIds

public Map<String,Long> userIds()

Returns:

the map of <Username,ID>

blacklist

public Set<Long> blacklist()

Returns:

a blacklist containing all the IDs of the banned users

admins

public Set<Long> admins()

Returns:

an admin set of all the IDs of bot administrators

consume

public void consume(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.

Specified by:

consume in interface LongPollingSingleThreadUpdateConsumer

Parameters:

update - the update received by Telegram's API

getPrivacy

public Privacy getPrivacy(Update update,
 long id)

isGroupAdmin

public boolean isGroupAdmin(Update update,
 long id)

isGroupAdmin

public boolean isGroupAdmin(long chatId,
 long id)

isCreator

public boolean isCreator(long id)

isAdmin

public boolean isAdmin(long id)

checkGlobalFlags

protected boolean checkGlobalFlags(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

getCommandPrefix

protected String getCommandPrefix()

getCommandRegexSplit

protected String getCommandRegexSplit()

allowContinuousText

protected boolean allowContinuousText()

addExtension

protected void addExtension(AbilityExtension extension)

addExtensions

protected void addExtensions(AbilityExtension... extensions)

addExtensions

protected void addExtensions(Collection<AbilityExtension> extensions)