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 DefaultAbsSender.

All bots extending the BaseAbilityBot get implicit abilities:

  • /claim - Claims this 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 Details

  • Constructor Details

  • Method Details

    • creatorId

      public abstract long creatorId()

    • onRegister

      public void onRegister()

    • db

      public DBContext db()
      Returns:
      the database of this bot

    • sender

      public MessageSender sender()
      Returns:
      the message sender for this bot

    • silent

      public SilentSender silent()
      Returns:
      the silent sender for this bot

    • users

      public Map<Long,org.telegram.telegrambots.meta.api.objects.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

    • stats

      public Map<String,Stats> stats()
      Returns:
      a mapping of ability and reply names to their corresponding statistics

    • abilities

      public Map<String,Ability> abilities()
      Returns:
      the immutable map of <String,Ability>

    • 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()

    • getPrivacy

      public Privacy getPrivacy(org.telegram.telegrambots.meta.api.objects.Update update, long id)

    • isGroupAdmin

      public boolean isGroupAdmin(org.telegram.telegrambots.meta.api.objects.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(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

    • 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)