Package io.github.natanimn.telebof

Class BotClient

java.lang.Object

io.github.natanimn.telebof.BotClient

public final class BotClient
extends Object

Main class of Telebof library

Since:

3 March 2025

Author:

Natanim

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BotClient.Builder	A builder of BotClient class.
(package private) static final record	BotClient.UpdateInfo

Field Summary

Fields

Modifier and Type	Field	Description
private User	bot
final BotContext	context
private final Dispatcher	dispatcher
private final ExecutorService	executor
private final GetUpdates	getUpdates
private Boolean	isConnected
private Integer	offset
private final ExecutorService	pollingExecutor
private boolean	skipOldUpdates
private final AtomicBoolean	stopPolling
private final StateMemoryStorage	storage
private static final Map<Function<Update,TelegramUpdate>,Updates>	updateMap

Constructor Summary

Constructors

Modifier	Constructor	Description
	BotClient(String botToken)
private	BotClient(String botToken, boolean skipOldUpdates, int limit, Integer offset, int timeout, Updates[] allowedUpdates, Proxy proxy, String localBotApiUrl, boolean useTestServer, int numThreads)

Method Summary

Modifier and Type	Method	Description
private void	addBusinessConnectionHandler(BusinessConnectionHandler handler, MethodHandle method)
private void	addBusinessMessageHandler(BusinessMessageHandler handler, MethodHandle method)
private void	addCallbackHandler(CallbackHandler handler, MethodHandle method)
private void	addChannelPostHandler(ChannelPostHandler handler, MethodHandle method)
private void	addChatBoostHandler(ChatBoostHandler handler, MethodHandle method)
private void	addChatJoinRequestHandler(ChatJoinRequestHandler handler, MethodHandle method)
private void	addChatMemberHandler(ChatMemberHandler handler, MethodHandle method)
private void	addChosenInlineHandler(ChosenInlineHandler handler, MethodHandle method)
private void	addDeletedBusinessMessageHandler(DeletedBusinessMessageHandler handler, MethodHandle method)
private void	addEditedBusinessMessageHandler(EditedBusinessMessageHandler handler, MethodHandle method)
private void	addEditedChannelPostHandler(EditedChannelPostHandler handler, MethodHandle method)
private void	addEditedMessageHandler(EditedMessageHandler handler, MethodHandle method)
void	addHandler(Object object)
private void	addInlineHandler(InlineHandler handler, MethodHandle method)
private void	addMessageHandler(MessageHandler handler, MethodHandle method)
private void	addMyChatMemberHandler(MyChatMemberHandler handler, MethodHandle method)
private void	addPollAnswerHandler(PollAnswerHandler handler, MethodHandle method)
private void	addPollHandler(PollHandler handler, MethodHandle method)
private void	addPreCheckoutHandler(PreCheckoutHandler handler, MethodHandle method)
private void	addPurchasedPaidMediaHandler(PurchasedPaidMediaHandler handler, MethodHandle method)
private void	addReactionCountHandler(ReactionCountHandler handler, MethodHandle method)
private void	addReactionHandler(ReactionHandler handler, MethodHandle method)
private void	addRemovedChatBoostHandler(RemovedChatBoostHandler handler, MethodHandle method)
private void	addShippingHandler(ShippingHandler handler, MethodHandle method)
private void	addToList(MethodHandle handle, Method method, List<AnnotatedHandler> annotatedMethods)
private <T extends TelegramUpdate> void	executeUpdate(Updates updateName, Filter filter, TelegramUpdate update)
private BotClient.UpdateInfo	getInfoFromUpdate(Update update)
User	me()
void	onBusinessConnection(FilterExecutor executor, UpdateHandler<BusinessConnection> handler)	Use this method to register new handler for incoming Update.getBusinessConnection() update.
void	onBusinessMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.getBusinessMessage() update.
void	onCallback(FilterExecutor executor, UpdateHandler<CallbackQuery> handler)	Use this method to register new handler for incoming Update.getCallbackQuery() update.
void	onChannelPost(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.getChannelPost() update.
void	onChatBoost(FilterExecutor executor, UpdateHandler<ChatBoostUpdated> handler)	Use this method to register new handler for incoming Update.getChatBoost() update.
void	onChatJoinRequest(FilterExecutor executor, UpdateHandler<ChatJoinRequest> handler)	Use this method to register new handler for incoming Update.getChatJoinRequest() update.
void	onChatMember(FilterExecutor executor, UpdateHandler<ChatMemberUpdated> handler)	Use this method to register new handler for incoming Update.getChatMember() update.
void	onChosenInlineResult(FilterExecutor executor, UpdateHandler<ChosenInlineResult> handler)	Use this method to register new handler for incoming Update.getChosenInlineResult() update.
void	onDeletedBusinessMessage(FilterExecutor executor, UpdateHandler<BusinessMessagesDeleted> handler)	Use this method to register new handler for incoming Update.getDeletedBusinessMessages() update.
void	onEditedBusinessMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.getEditedBusinessMessage() update.
void	onEditedChannelPost(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.getEditedChannelPost() update.
void	onEditedMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.getEditedMessage() update.
void	onInline(FilterExecutor executor, UpdateHandler<InlineQuery> handler)	Use this method to register new handler for incoming Update.getInlineQuery() update.
void	onMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.getMessage() update.
void	onMyChatMember(FilterExecutor executor, UpdateHandler<ChatMemberUpdated> handler)	Use this method to register new handler for incoming Update.getMyChatMember() update.
void	onPoll(FilterExecutor executor, UpdateHandler<Poll> handler)	Use this method to register new handler for incoming Update.getPoll() update.
void	onPollAnswer(FilterExecutor executor, UpdateHandler<PollAnswer> handler)	Use this method to register new handler for incoming Update.getPollAnswer() update.
void	onPreCheckout(FilterExecutor executor, UpdateHandler<PreCheckoutQuery> handler)	Use this method to register new handler for incoming Update.getPreCheckoutQuery() update.
void	onPurchasedPaidMedia(FilterExecutor executor, UpdateHandler<PaidMediaPurchased> handler)	Use this method to register new handler for incoming Update.getPurchasedPaidMedia() update.
void	onReaction(FilterExecutor executor, UpdateHandler<MessageReactionUpdated> handler)	Use this method to register new handler for incoming Update.getMessageReaction() update.
void	onReactionCount(FilterExecutor executor, UpdateHandler<MessageReactionCountUpdated> handler)	Use this method to register new handler for incoming Update.getMessageReactionCount() update.
void	onRemovedChatBoost(FilterExecutor executor, UpdateHandler<ChatBoostRemoved> handler)	Use this method to register new handler for incoming Update.getRemovedChatBoost() update.
void	onShipping(FilterExecutor executor, UpdateHandler<ShippingQuery> handler)	Use this method to register new handler for incoming Update.getShippingQuery() update.
void	processUpdates(List<Update> updates)	Process updates retrieved from long polling or webhook
private void	retrieveUpdates()	Retrieve updates
private void	runOnNewThread()
private void	setOffset(int offset)
private void	shutDown()
private void	sleep(int seconds)
void	startPolling()	Use this method to run the bot using long polling
void	stop()	Stop the bot

Methods inherited from class java.lang.Object

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

Field Details

offset

private Integer offset

stopPolling

private final AtomicBoolean stopPolling

skipOldUpdates

private boolean skipOldUpdates

executor

private final ExecutorService executor

bot

private User bot

storage

private final StateMemoryStorage storage

dispatcher

private final Dispatcher dispatcher

context

public final BotContext context

isConnected

private Boolean isConnected

pollingExecutor

private final ExecutorService pollingExecutor

getUpdates

private final GetUpdates getUpdates

updateMap

private static final Map<Function<Update,TelegramUpdate>,Updates> updateMap

Constructor Details

BotClient

private BotClient(String botToken,
 boolean skipOldUpdates,
 int limit,
 Integer offset,
 int timeout,
 Updates[] allowedUpdates,
 Proxy proxy,
 String localBotApiUrl,
 boolean useTestServer,
 int numThreads)

Parameters:

botToken - bot token obtained from @BotFather

skipOldUpdates - skip last 24 hours update(supported on long polling)

limit - number of updates to receive(supported on long polling)

offset - offset (supported on long polling)

timeout - timeout (supported on long polling)

allowedUpdates - allowed updates to receive

proxy - custom proxy

localBotApiUrl - local bot api url

useTestServer - test server

numThreads - number of threads to run handlers parallel

BotClient

public BotClient(String botToken)

Method Details

onMessage

public void onMessage(FilterExecutor executor,
 UpdateHandler<Message> handler)

Use this method to register new handler for incoming Update.getMessage() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onCallback

public void onCallback(FilterExecutor executor,
 UpdateHandler<CallbackQuery> handler)

Use this method to register new handler for incoming Update.getCallbackQuery() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onInline

public void onInline(FilterExecutor executor,
 UpdateHandler<InlineQuery> handler)

Use this method to register new handler for incoming Update.getInlineQuery() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onPoll

public void onPoll(FilterExecutor executor,
 UpdateHandler<Poll> handler)

Use this method to register new handler for incoming Update.getPoll() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onMyChatMember

public void onMyChatMember(FilterExecutor executor,
 UpdateHandler<ChatMemberUpdated> handler)

Use this method to register new handler for incoming Update.getMyChatMember() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onPollAnswer

public void onPollAnswer(FilterExecutor executor,
 UpdateHandler<PollAnswer> handler)

Use this method to register new handler for incoming Update.getPollAnswer() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onPreCheckout

public void onPreCheckout(FilterExecutor executor,
 UpdateHandler<PreCheckoutQuery> handler)

Use this method to register new handler for incoming Update.getPreCheckoutQuery() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onChatMember

public void onChatMember(FilterExecutor executor,
 UpdateHandler<ChatMemberUpdated> handler)

Use this method to register new handler for incoming Update.getChatMember() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onEditedMessage

public void onEditedMessage(FilterExecutor executor,
 UpdateHandler<Message> handler)

Use this method to register new handler for incoming Update.getEditedMessage() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onChannelPost

public void onChannelPost(FilterExecutor executor,
 UpdateHandler<Message> handler)

Use this method to register new handler for incoming Update.getChannelPost() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onEditedChannelPost

public void onEditedChannelPost(FilterExecutor executor,
 UpdateHandler<Message> handler)

Use this method to register new handler for incoming Update.getEditedChannelPost() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onChatJoinRequest

public void onChatJoinRequest(FilterExecutor executor,
 UpdateHandler<ChatJoinRequest> handler)

Use this method to register new handler for incoming Update.getChatJoinRequest() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onChosenInlineResult

public void onChosenInlineResult(FilterExecutor executor,
 UpdateHandler<ChosenInlineResult> handler)

Use this method to register new handler for incoming Update.getChosenInlineResult() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onShipping

public void onShipping(FilterExecutor executor,
 UpdateHandler<ShippingQuery> handler)

Use this method to register new handler for incoming Update.getShippingQuery() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onReaction

public void onReaction(FilterExecutor executor,
 UpdateHandler<MessageReactionUpdated> handler)

Use this method to register new handler for incoming Update.getMessageReaction() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onReactionCount

public void onReactionCount(FilterExecutor executor,
 UpdateHandler<MessageReactionCountUpdated> handler)

Use this method to register new handler for incoming Update.getMessageReactionCount() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onChatBoost

public void onChatBoost(FilterExecutor executor,
 UpdateHandler<ChatBoostUpdated> handler)

Use this method to register new handler for incoming Update.getChatBoost() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onRemovedChatBoost

public void onRemovedChatBoost(FilterExecutor executor,
 UpdateHandler<ChatBoostRemoved> handler)

Use this method to register new handler for incoming Update.getRemovedChatBoost() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onBusinessConnection

public void onBusinessConnection(FilterExecutor executor,
 UpdateHandler<BusinessConnection> handler)

Use this method to register new handler for incoming Update.getBusinessConnection() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onBusinessMessage

public void onBusinessMessage(FilterExecutor executor,
 UpdateHandler<Message> handler)

Use this method to register new handler for incoming Update.getBusinessMessage() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onEditedBusinessMessage

public void onEditedBusinessMessage(FilterExecutor executor,
 UpdateHandler<Message> handler)

Use this method to register new handler for incoming Update.getEditedBusinessMessage() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onDeletedBusinessMessage

public void onDeletedBusinessMessage(FilterExecutor executor,
 UpdateHandler<BusinessMessagesDeleted> handler)

Use this method to register new handler for incoming Update.getDeletedBusinessMessages() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

onPurchasedPaidMedia

public void onPurchasedPaidMedia(FilterExecutor executor,
 UpdateHandler<PaidMediaPurchased> handler)

Use this method to register new handler for incoming Update.getPurchasedPaidMedia() update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

addMessageHandler

private void addMessageHandler(MessageHandler handler,
 MethodHandle method)

addEditedMessageHandler

private void addEditedMessageHandler(EditedMessageHandler handler,
 MethodHandle method)

addCallbackHandler

private void addCallbackHandler(CallbackHandler handler,
 MethodHandle method)

addChannelPostHandler

private void addChannelPostHandler(ChannelPostHandler handler,
 MethodHandle method)

addEditedChannelPostHandler

private void addEditedChannelPostHandler(EditedChannelPostHandler handler,
 MethodHandle method)

addInlineHandler

private void addInlineHandler(InlineHandler handler,
 MethodHandle method)

addPollHandler

private void addPollHandler(PollHandler handler,
 MethodHandle method)

addPollAnswerHandler

private void addPollAnswerHandler(PollAnswerHandler handler,
 MethodHandle method)

addReactionHandler

private void addReactionHandler(ReactionHandler handler,
 MethodHandle method)

addReactionCountHandler

private void addReactionCountHandler(ReactionCountHandler handler,
 MethodHandle method)

addChatJoinRequestHandler

private void addChatJoinRequestHandler(ChatJoinRequestHandler handler,
 MethodHandle method)

addPurchasedPaidMediaHandler

private void addPurchasedPaidMediaHandler(PurchasedPaidMediaHandler handler,
 MethodHandle method)

addPreCheckoutHandler

private void addPreCheckoutHandler(PreCheckoutHandler handler,
 MethodHandle method)

addShippingHandler

private void addShippingHandler(ShippingHandler handler,
 MethodHandle method)

addChatBoostHandler

private void addChatBoostHandler(ChatBoostHandler handler,
 MethodHandle method)

addChatMemberHandler

private void addChatMemberHandler(ChatMemberHandler handler,
 MethodHandle method)

addMyChatMemberHandler

private void addMyChatMemberHandler(MyChatMemberHandler handler,
 MethodHandle method)

addRemovedChatBoostHandler

private void addRemovedChatBoostHandler(RemovedChatBoostHandler handler,
 MethodHandle method)

addBusinessMessageHandler

private void addBusinessMessageHandler(BusinessMessageHandler handler,
 MethodHandle method)

addBusinessConnectionHandler

private void addBusinessConnectionHandler(BusinessConnectionHandler handler,
 MethodHandle method)

addDeletedBusinessMessageHandler

private void addDeletedBusinessMessageHandler(DeletedBusinessMessageHandler handler,
 MethodHandle method)

addEditedBusinessMessageHandler

private void addEditedBusinessMessageHandler(EditedBusinessMessageHandler handler,
 MethodHandle method)

addChosenInlineHandler

private void addChosenInlineHandler(ChosenInlineHandler handler,
 MethodHandle method)

addToList

private void addToList(MethodHandle handle,
 Method method,
 List<AnnotatedHandler> annotatedMethods)

addHandler

public void addHandler(Object object)

executeUpdate

private <T extends TelegramUpdate> void executeUpdate(Updates updateName,
 Filter filter,
 TelegramUpdate update)

stop

public void stop()

Stop the bot

me

public User me()

getInfoFromUpdate

private BotClient.UpdateInfo getInfoFromUpdate(Update update)

processUpdates

public void processUpdates(List<Update> updates)

Process updates retrieved from long polling or webhook

Parameters:

updates - array of Update

retrieveUpdates

private void retrieveUpdates()
                      throws InterruptedException

Retrieve updates

Throws:

InterruptedException - exception

shutDown

private void shutDown()

runOnNewThread

private void runOnNewThread()

startPolling

public void startPolling()

Use this method to run the bot using long polling

setOffset

private void setOffset(int offset)

sleep

private void sleep(int seconds)