Index

A B C D E F G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

a() - Method in class Pair

a() - Method in class Trio

Ability - Class in org.telegram.telegrambots.abilitybots.api.objects

An ability is a fully-fledged bot action that contains all the necessary information to process: A response to a command A post-response to a command A reply to a sequence of actions

ABILITY_BAN_FAIL - Static variable in class AbilityMessageCodes

ABILITY_BAN_SUCCESS - Static variable in class AbilityMessageCodes

ABILITY_CLAIM_FAIL - Static variable in class AbilityMessageCodes

ABILITY_CLAIM_SUCCESS - Static variable in class AbilityMessageCodes

ABILITY_COMMANDS_NOT_FOUND - Static variable in class AbilityMessageCodes

ABILITY_DEMOTE_FAIL - Static variable in class AbilityMessageCodes

ABILITY_DEMOTE_SUCCESS - Static variable in class AbilityMessageCodes

ABILITY_PROMOTE_FAIL - Static variable in class AbilityMessageCodes

ABILITY_PROMOTE_SUCCESS - Static variable in class AbilityMessageCodes

ABILITY_RECOVER_ERROR - Static variable in class AbilityMessageCodes

ABILITY_RECOVER_FAIL - Static variable in class AbilityMessageCodes

ABILITY_RECOVER_MESSAGE - Static variable in class AbilityMessageCodes

ABILITY_RECOVER_SUCCESS - Static variable in class AbilityMessageCodes

ABILITY_UNBAN_FAIL - Static variable in class AbilityMessageCodes

ABILITY_UNBAN_SUCCESS - Static variable in class AbilityMessageCodes

Ability.AbilityBuilder - Class in org.telegram.telegrambots.abilitybots.api.objects

AbilityBot - Class in org.telegram.telegrambots.abilitybots.api.bot

The default AbilityBot class implements LongPollingSingleThreadUpdateConsumer.

AbilityBot(TelegramClient, String) - Constructor for class AbilityBot

AbilityBot(TelegramClient, String, DBContext) - Constructor for class AbilityBot

AbilityBot(TelegramClient, String, DBContext, AbilityToggle) - Constructor for class AbilityBot

AbilityBot(TelegramClient, String, AbilityToggle) - Constructor for class AbilityBot

AbilityExtension - Interface in org.telegram.telegrambots.abilitybots.api.util

An interface to mark a class as an extension.

AbilityMessageCodes - Class in org.telegram.telegrambots.abilitybots.api.util

AbilityMessageCodes() - Constructor for class AbilityMessageCodes

AbilityToggle - Interface in org.telegram.telegrambots.abilitybots.api.toggle

This interface can be used to toggle or customize unwanted default abilities by the user.

AbilityUtils - Class in org.telegram.telegrambots.abilitybots.api.util

Helper and utility methods

AbilityWebhookBot - Class in org.telegram.telegrambots.abilitybots.api.bot

A TelegramWebhookBot-flavor AbilityBot.

AbilityWebhookBot(TelegramClient, String, String) - Constructor for class AbilityWebhookBot

AbilityWebhookBot(TelegramClient, String, String, DBContext) - Constructor for class AbilityWebhookBot

AbilityWebhookBot(TelegramClient, String, String, DBContext, AbilityToggle) - Constructor for class AbilityWebhookBot

AbilityWebhookBot(TelegramClient, String, String, AbilityToggle) - Constructor for class AbilityWebhookBot

action - Variable in class Reply

action() - Method in class Ability

action() - Method in class Reply

action(BiConsumer<BaseAbilityBot, Update>) - Method in class ReplyFlow.ReplyFlowBuilder

action(Consumer<MessageContext>) - Method in class Ability.AbilityBuilder

actOn(BaseAbilityBot, Update) - Method in class Reply

addExtension(AbilityExtension) - Method in class BaseAbilityBot

addExtensions(Collection<AbilityExtension>) - Method in class BaseAbilityBot

addExtensions(AbilityExtension...) - Method in class BaseAbilityBot

addTag(String) - Static method in class AbilityUtils

ADMIN - Enum constant in enum class Privacy

A global admin of the bot, regardless of the group the bot is in.

admins() - Method in class BaseAbilityBot

ADMINS - Static variable in class BaseAbilityBot

ALL - Enum constant in enum class Locality

Ability would be valid for groups and private user chats

allowContinuousText() - Method in class BaseAbilityBot

arguments() - Method in class MessageContext

If there's no message in the update, then this will an empty array.

B

b() - Method in class Pair

b() - Method in class Trio

backup() - Method in interface DBContext

Implementations of this method are free to return any object such as XML, JSON, etc...

backup() - Method in class MapDBContext

BACKUP - Static variable in class DefaultAbilities

BACKUP_ENABLED - Enum constant in enum class CustomToggle.Property

BACKUP_TOGGLE - Enum constant in enum class CustomToggle.Property

backupDB() - Method in class DefaultAbilities

This backup ability returns the object defined by DBContext.backup() as a message document.

BackupVar<T> - Class in org.telegram.telegrambots.abilitybots.api.db

BAN - Static variable in class DefaultAbilities

BAN_ENABLED - Enum constant in enum class CustomToggle.Property

BAN_TOGGLE - Enum constant in enum class CustomToggle.Property

banUser() - Method in class DefaultAbilities

Banned users are accumulated in the blacklist.

BareboneToggle - Class in org.telegram.telegrambots.abilitybots.api.toggle

This toggle can be used as-is to turn off ALL the default abilities supplied by the library.

BareboneToggle() - Constructor for class BareboneToggle

BaseAbilityBot - Class in org.telegram.telegrambots.abilitybots.api.bot

The father of all ability bots.

BaseAbilityBot(TelegramClient, String, DBContext, AbilityToggle) - Constructor for class BaseAbilityBot

basedOn(Ability) - Method in class Ability.AbilityBuilder

blacklist() - Method in class BaseAbilityBot

BLACKLIST - Static variable in class BaseAbilityBot

bot() - Method in class MessageContext

build() - Method in class Ability.AbilityBuilder

build() - Method in class ReplyFlow.ReplyFlowBuilder

builder() - Static method in class Ability

builder(DBContext) - Static method in class ReplyFlow

builder(DBContext, int) - Static method in class ReplyFlow

C

c() - Method in class Trio

CALLBACK_QUERY - Enum constant in enum class Flag

CAPTION - Enum constant in enum class Flag

CHANNEL_POST - Enum constant in enum class Flag

CHAT_JOIN_REQUEST - Enum constant in enum class Flag

CHAT_MEMBER - Enum constant in enum class Flag

chatId() - Method in class MessageContext

CHECK_INPUT_FAIL - Static variable in class AbilityMessageCodes

CHECK_LOCALITY_FAIL - Static variable in class AbilityMessageCodes

CHECK_PRIVACY_FAIL - Static variable in class AbilityMessageCodes

checkGlobalFlags(Update) - Method in class BaseAbilityBot

Test the update against the provided global flags.

CHOSEN_INLINE_QUERY - Enum constant in enum class Flag

CLAIM - Static variable in class DefaultAbilities

CLAIM_ENABLED - Enum constant in enum class CustomToggle.Property

CLAIM_TOGGLE - Enum constant in enum class CustomToggle.Property

claimCreator() - Method in class DefaultAbilities

Regular users and admins who try to claim the bot will get banned.

clear() - Method in interface DBContext

Clears the data structures present in the database.

clear() - Method in class MapDBContext

close() - Method in class MapDBContext

commands() - Method in class DefaultAbilities

Default format:

COMMANDS - Static variable in class DefaultAbilities

COMMANDS_ENABLED - Enum constant in enum class CustomToggle.Property

COMMANDS_TOGGLE - Enum constant in enum class CustomToggle.Property

commit() - Method in interface DBContext

Commits the database to its persistent layer.

commit() - Method in class MapDBContext

commitTo(DBContext) - Static method in class AbilityUtils

Commits to DB.

conditions - Variable in class Reply

conditions() - Method in class Reply

config(Properties) - Method in class CustomToggle

consume(Update) - Method in class AbilityBot

consume(Update) - Method in class BaseAbilityBot

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

consumeUpdate(Update) - Method in class AbilityWebhookBot

contains(String) - Method in interface DBContext

contains(String) - Method in class MapDBContext

createStats(String, long) - Static method in class Stats

createVar(R) - Static method in class BackupVar

CREATOR - Enum constant in enum class Privacy

The creator of the bot.

creatorId() - Method in class BaseAbilityBot

CustomToggle - Class in org.telegram.telegrambots.abilitybots.api.toggle

This custom toggle can be used to customize default abilities supplied by the library.

CustomToggle() - Constructor for class CustomToggle

CustomToggle.Property - Enum Class in org.telegram.telegrambots.abilitybots.api.toggle

List of all the properties recognized by CustomToggle.

D

db - Variable in class BaseAbilityBot

DBContext - Interface in org.telegram.telegrambots.abilitybots.api.db

This interface represents the high-level methods exposed to the user when handling an Update.

DEFAULT - Static variable in class BaseAbilityBot

DefaultAbilities - Class in org.telegram.telegrambots.abilitybots.api.bot

DefaultAbilities(BaseAbilityBot) - Constructor for class DefaultAbilities

DefaultToggle - Class in org.telegram.telegrambots.abilitybots.api.toggle

If the user does not supply a toggle to their constructor, the default toggle will be instantiated.

DefaultToggle() - Constructor for class DefaultToggle

DEMOTE - Static variable in class DefaultAbilities

DEMOTE_ENABLED - Enum constant in enum class CustomToggle.Property

DEMOTE_TOGGLE - Enum constant in enum class CustomToggle.Property

demoteAdmin() - Method in class DefaultAbilities

DOCUMENT - Enum constant in enum class Flag

downloadFileWithId(String) - Method in class DefaultAbilities

E

EDITED_CHANNEL_POST - Enum constant in enum class Flag

EDITED_MESSAGE - Enum constant in enum class Flag

EMPTY_USER - Static variable in class AbilityUtils

enableStats() - Method in class Ability.AbilityBuilder

enableStats(String) - Method in class Reply

enableStats(String) - Method in class ReplyFlow.ReplyFlowBuilder

equals(Object) - Method in class BackupVar

equals(Object) - Method in class MapDBVar

equals(Object) - Method in class Ability

equals(Object) - Method in class MessageContext

equals(Object) - Method in class Reply

equals(Object) - Method in class Stats

equals(Object) - Method in class Pair

equals(Object) - Method in class Trio

escape(String) - Static method in class AbilityUtils

execute(Method) - Method in class SilentSender

executeAsync(Method, Callback) - Method in class SilentSender

F

firstArg() - Method in class MessageContext

flag(Predicate<Update>...) - Method in class Ability.AbilityBuilder

Flag - Enum Class in org.telegram.telegrambots.abilitybots.api.objects

Flags are an conditions that are applied on an Update.

flags() - Method in class Ability

forceReply(String, long) - Method in class SilentSender

fullName(User) - Static method in class AbilityUtils

The full name is identified as the concatenation of the first and last name, separated by a space.

G

get() - Method in class MapDBVar

get() - Method in interface Var

getBotPath() - Method in class AbilityWebhookBot

getChatId(Update) - Static method in class AbilityUtils

Fetches the direct chat ID of the specified update.

getCommandPrefix() - Method in class BaseAbilityBot

getCommandRegexSplit() - Method in class BaseAbilityBot

getList(String) - Method in interface DBContext

getList(String) - Method in class MapDBContext

getLocalizedMessage(String, String, Object...) - Static method in class AbilityUtils

getLocalizedMessage(String, Locale, Object...) - Static method in class AbilityUtils

getMap(String) - Method in interface DBContext

getMap(String) - Method in class MapDBContext

getPrivacy(Update, long) - Method in class BaseAbilityBot

getReplies() - Method in class ReplyCollection

getSet(String) - Method in interface DBContext

getSet(String) - Method in class MapDBContext

getUser(Update) - Static method in class AbilityUtils

Fetches the user who caused the update.

getVar(String) - Method in interface DBContext

getVar(String) - Method in class MapDBContext

GROUP - Enum constant in enum class Locality

Only group chats

GROUP_ADMIN - Enum constant in enum class Privacy

Only group admins would get to initiate this command.

H

HAS_BUSINESS_CONNECTION - Enum constant in enum class Flag

HAS_BUSINESS_MESSAGE - Enum constant in enum class Flag

HAS_DELETED_BUSINESS_MESSAGE - Enum constant in enum class Flag

HAS_EDITED_BUSINESS_MESSAGE - Enum constant in enum class Flag

hashCode() - Method in class BackupVar

hashCode() - Method in class MapDBVar

hashCode() - Method in class Ability

hashCode() - Method in class MessageContext

hashCode() - Method in class Reply

hashCode() - Method in class Stats

hashCode() - Method in class Pair

hashCode() - Method in class Trio

hit() - Method in class Stats

hits() - Method in class Stats

I

info() - Method in class Ability

info(String) - Method in interface DBContext

info(String) - Method in class MapDBContext

info(String) - Method in class Ability.AbilityBuilder

INLINE_QUERY - Enum constant in enum class Flag

input(int) - Method in class Ability.AbilityBuilder

isAdmin(long) - Method in class BaseAbilityBot

isCreator(long) - Method in class BaseAbilityBot

isGroupAdmin(long, long) - Method in class BaseAbilityBot

isGroupAdmin(Update, long) - Method in class BaseAbilityBot

isGroupUpdate(Update) - Static method in class AbilityUtils

A "best-effort" boolean stating whether the update is a group message or not.

isOff(Ability) - Method in interface AbilityToggle

isOff(Ability) - Method in class BareboneToggle

isOff(Ability) - Method in class CustomToggle

isOff(Ability) - Method in class DefaultToggle

isOkFor(Update) - Method in class Reply

isReplyTo(String) - Static method in class AbilityUtils

isSuperGroupUpdate(Update) - Static method in class AbilityUtils

A "best-effort" boolean stating whether the update is a super-group message or not.

isUserMessage(Update) - Static method in class AbilityUtils

isValidCommand(String) - Static method in class AbilityUtils

Checks if the passed string is a valid bot command according to the requirements of Telegram Bot API: "A command must always start with the '/' symbol and may not be longer than 32 characters.

isValidCommandName(String) - Static method in class AbilityUtils

Checks if the passed String is a valid command name.

K

key() - Method in enum class CustomToggle.Property

L

locality() - Method in class Ability

locality(Locality) - Method in class Ability.AbilityBuilder

Locality - Enum Class in org.telegram.telegrambots.abilitybots.api.objects

Locality identifies the location in which you want your message to be accessed.

LOCATION - Enum constant in enum class Flag

M

MapDBContext - Class in org.telegram.telegrambots.abilitybots.api.db

An implementation of DBContext that relies on a DB.

MapDBContext(DB) - Constructor for class MapDBContext

MapDBVar<T> - Class in org.telegram.telegrambots.abilitybots.api.db

The MapDB variant for DBContext.getVar(String).

MapDBVar(Atomic.Var<T>) - Constructor for class MapDBVar

MESSAGE - Enum constant in enum class Flag

MessageContext - Class in org.telegram.telegrambots.abilitybots.api.objects

MessageContext is a wrapper class to the Update, originating end-user and the arguments present in its message (if any).

MY_CHAT_MEMBER - Enum constant in enum class Flag

N

name() - Method in class Ability

name() - Method in class Reply

name() - Method in class Stats

name(String) - Method in class Ability.AbilityBuilder

newContext(Update, User, Long, BaseAbilityBot, String...) - Static method in class MessageContext

next(Reply) - Method in class ReplyFlow.ReplyFlowBuilder

next(ReplyFlow) - Method in class ReplyFlow.ReplyFlowBuilder

nextReplies() - Method in class ReplyFlow

NONE - Enum constant in enum class Flag

O

of(A, B) - Static method in class Pair

of(A, B, C) - Static method in class Trio

of(BiConsumer<BaseAbilityBot, Update>, Predicate<Update>...) - Static method in class Reply

of(BiConsumer<BaseAbilityBot, Update>, List<Predicate<Update>>) - Static method in class Reply

of(Reply...) - Static method in class ReplyCollection

OFF - Static variable in class CustomToggle

offlineInstance(String) - Static method in class MapDBContext

This DB returned by this method gets deleted on JVM shutdown.

onException(BotApiMethod<T>, Exception) - Method in interface SentCallback

Called when an exception is thrown

onlineInstance(String) - Static method in class MapDBContext

This DB returned by this method does not trigger deletion on JVM shutdown.

onlyIf(Predicate<Update>) - Method in class ReplyFlow.ReplyFlowBuilder

onRegister() - Method in class BaseAbilityBot

onResult(BotApiMethod<T>, T) - Method in interface SentCallback

Called when the request is successful

org.telegram.telegrambots.abilitybots.api.bot - package org.telegram.telegrambots.abilitybots.api.bot

org.telegram.telegrambots.abilitybots.api.db - package org.telegram.telegrambots.abilitybots.api.db

org.telegram.telegrambots.abilitybots.api.objects - package org.telegram.telegrambots.abilitybots.api.objects

org.telegram.telegrambots.abilitybots.api.sender - package org.telegram.telegrambots.abilitybots.api.sender

org.telegram.telegrambots.abilitybots.api.toggle - package org.telegram.telegrambots.abilitybots.api.toggle

org.telegram.telegrambots.abilitybots.api.util - package org.telegram.telegrambots.abilitybots.api.util

P

Pair<A,B> - Class in org.telegram.telegrambots.abilitybots.api.util

PHOTO - Enum constant in enum class Flag

POLL - Enum constant in enum class Flag

POLL_ANSWER - Enum constant in enum class Flag

post(Consumer<MessageContext>) - Method in class Ability.AbilityBuilder

postAction() - Method in class Ability

PRECHECKOUT_QUERY - Enum constant in enum class Flag

privacy() - Method in class Ability

privacy(Privacy) - Method in class Ability.AbilityBuilder

Privacy - Enum Class in org.telegram.telegrambots.abilitybots.api.objects

Privacy represents a restriction on who can use the ability.

processAbility(Ability) - Method in interface AbilityToggle

Abilities that are ON (and have failed the AbilityToggle.isOff(org.telegram.telegrambots.abilitybots.api.objects.Ability) condition) will be processed by this method.

processAbility(Ability) - Method in class BareboneToggle

processAbility(Ability) - Method in class CustomToggle

processAbility(Ability) - Method in class DefaultToggle

PROMOTE - Static variable in class DefaultAbilities

PROMOTE_ENABLED - Enum constant in enum class CustomToggle.Property

PROMOTE_TOGGLE - Enum constant in enum class CustomToggle.Property

promoteAdmin() - Method in class DefaultAbilities

PUBLIC - Enum constant in enum class Privacy

Anybody who is not a bot admin or its creator will be considered as a public user.

R

recover(Object) - Method in interface DBContext

The object passed to this method need to conform to the implementation of the DBContext.backup() method.

recover(Object) - Method in class MapDBContext

RECOVER - Static variable in class DefaultAbilities

RECOVER_ENABLED - Enum constant in enum class CustomToggle.Property

RECOVER_TOGGLE - Enum constant in enum class CustomToggle.Property

recoverDB() - Method in class DefaultAbilities

Recovers the bot database using DBContext.recover(Object).

replies - Variable in class ReplyCollection

replies() - Method in class Ability

reply(BiConsumer<BaseAbilityBot, Update>, Predicate<Update>...) - Method in class Ability.AbilityBuilder

reply(Reply) - Method in class Ability.AbilityBuilder

Reply - Class in org.telegram.telegrambots.abilitybots.api.objects

A reply consists of update conditionals and an action to be applied on the update.

REPLY - Enum constant in enum class Flag

ReplyCollection - Class in org.telegram.telegrambots.abilitybots.api.objects

A wrapping object containing Replies.

ReplyCollection(Collection<Reply>) - Constructor for class ReplyCollection

ReplyFlow - Class in org.telegram.telegrambots.abilitybots.api.objects

ReplyFlow.ReplyFlowBuilder - Class in org.telegram.telegrambots.abilitybots.api.objects

REPORT - Static variable in class DefaultAbilities

REPORT_ENABLED - Enum constant in enum class CustomToggle.Property

REPORT_TOGGLE - Enum constant in enum class CustomToggle.Property

reportCommands() - Method in class DefaultAbilities

Format of the report:

reportStats() - Method in class DefaultAbilities

S

secondArg() - Method in class MessageContext

send(String, long) - Method in class SilentSender

sendMd(String, long) - Method in class SilentSender

SentCallback<T extends Serializable> - Interface in org.telegram.telegrambots.abilitybots.api.sender

set(T) - Method in class MapDBVar

set(T) - Method in interface Var

setStatsEnabled(boolean) - Method in class Ability.AbilityBuilder

SHIPPING_QUERY - Enum constant in enum class Flag

shortName(User) - Static method in class AbilityUtils

The short name is one of the following: First name Last name Username The method will try to return the first valid name in the specified order.

silent - Variable in class BaseAbilityBot

SilentSender - Class in org.telegram.telegrambots.abilitybots.api.sender

A silent sender that returns Optional objects upon execution.

SilentSender(TelegramClient) - Constructor for class SilentSender

STATES - Static variable in class ReplyFlow.ReplyFlowBuilder

Stats - Class in org.telegram.telegrambots.abilitybots.api.objects

Basic POJO to track ability and reply hits.

STATS - Static variable in class BaseAbilityBot

STATS - Static variable in class DefaultAbilities

STATS_ENABLED - Enum constant in enum class CustomToggle.Property

STATS_TOGGLE - Enum constant in enum class CustomToggle.Property

statsEnabled() - Method in class Ability

statsEnabled() - Method in class Reply

stream() - Method in class Reply

stream() - Method in class ReplyCollection

stream() - Method in class ReplyFlow

stripTag(String) - Static method in class AbilityUtils

summary() - Method in interface DBContext

summary() - Method in class MapDBContext

T

telegramClient - Variable in class BaseAbilityBot

test(Update) - Method in enum class Flag

TEXT - Enum constant in enum class Flag

thirdArg() - Method in class MessageContext

toggle(String, String) - Method in class CustomToggle

tokens() - Method in class Ability

toString() - Method in class BackupVar

toString() - Method in class MapDBVar

toString() - Method in class Ability

toString() - Method in class MessageContext

toString() - Method in class Reply

toString() - Method in class Stats

toString() - Method in class Pair

toString() - Method in class Trio

Trio<A,B,C> - Class in org.telegram.telegrambots.abilitybots.api.util

turnOff(String) - Method in class CustomToggle

U

UNBAN - Static variable in class DefaultAbilities

UNBAN_ENABLED - Enum constant in enum class CustomToggle.Property

UNBAN_TOGGLE - Enum constant in enum class CustomToggle.Property

unbanUser() - Method in class DefaultAbilities

Usage: /unban @username

update() - Method in class MessageContext

user() - Method in class MessageContext

USER - Enum constant in enum class Locality

Only user chats

USER_ID - Static variable in class BaseAbilityBot

USER_NOT_FOUND - Static variable in class AbilityMessageCodes

userIds() - Method in class BaseAbilityBot

users() - Method in class BaseAbilityBot

USERS - Static variable in class BaseAbilityBot

V

valueOf(String) - Static method in enum class Flag

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class Locality

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class Privacy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class CustomToggle.Property

Returns the enum constant of this class with the specified name.

values() - Static method in enum class Flag

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class Locality

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class Privacy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class CustomToggle.Property

Returns an array containing the constants of this enum class, in the order they are declared.

var() - Method in class BackupVar

Var<T> - Interface in org.telegram.telegrambots.abilitybots.api.db

The interface governing a variable for abstract getters and setters.

A B C D E F G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form