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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BotClient.Builder	A builder of BotClient class.

Field Summary

Fields

Modifier and Type	Field	Description
BotContext	context

Constructor Summary

Constructors

Constructor	Description
BotClient(String botToken)

Method Summary

Modifier and Type	Method	Description
void	addHandler(Object object)
User	me()
void	onBusinessConnection(FilterExecutor executor, UpdateHandler<BusinessConnection> handler)	Use this method to register new handler for incoming Update.business_connection update.
void	onBusinessMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.business_message update.
void	onCallback(FilterExecutor executor, UpdateHandler<CallbackQuery> handler)	Use this method to register new handler for incoming Update.callback_query update.
void	onChannelPost(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.channel_post update.
void	onChatBoost(FilterExecutor executor, UpdateHandler<ChatBoostUpdated> handler)	Use this method to register new handler for incoming Update.chat_boost update.
void	onChatJoinRequest(FilterExecutor executor, UpdateHandler<ChatJoinRequest> handler)	Use this method to register new handler for incoming Update.chat_join_request update.
void	onChatMember(FilterExecutor executor, UpdateHandler<ChatMemberUpdated> handler)	Use this method to register new handler for incoming Update.chat_member update.
void	onChosenInlineResult(FilterExecutor executor, UpdateHandler<ChosenInlineResult> handler)	Use this method to register new handler for incoming Update.chosen_inline_result update.
void	onDeletedBusinessMessage(FilterExecutor executor, UpdateHandler<BusinessMessagesDeleted> handler)	Use this method to register new handler for incoming Update.deleted_business_messages update.
void	onEditedBusinessMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.edited_business_message update.
void	onEditedChannelPost(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.edited_channel_post update.
void	onEditedMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.edited_message update.
void	onInline(FilterExecutor executor, UpdateHandler<InlineQuery> handler)	Use this method to register new handler for incoming Update.inline_query update.
void	onMessage(FilterExecutor executor, UpdateHandler<Message> handler)	Use this method to register new handler for incoming Update.message update.
void	onMyChatMember(FilterExecutor executor, UpdateHandler<ChatMemberUpdated> handler)	Use this method to register new handler for incoming Update.my_chat_member update.
void	onPoll(FilterExecutor executor, UpdateHandler<Poll> handler)	Use this method to register new handler for incoming Update.poll update.
void	onPollAnswer(FilterExecutor executor, UpdateHandler<PollAnswer> handler)	Use this method to register new handler for incoming Update.poll_answer update.
void	onPreCheckout(FilterExecutor executor, UpdateHandler<PreCheckoutQuery> handler)	Use this method to register new handler for incoming Update.pre_checkout_query update.
void	onPurchasedPaidMedia(FilterExecutor executor, UpdateHandler<PaidMediaPurchased> handler)	Use this method to register new handler for incoming Update.purchased_paid_media update.
void	onReaction(FilterExecutor executor, UpdateHandler<MessageReactionUpdated> handler)	Use this method to register new handler for incoming Update.message_reaction update.
void	onReactionCount(FilterExecutor executor, UpdateHandler<MessageReactionCountUpdated> handler)	Use this method to register new handler for incoming Update.message_reaction_count update.
void	onRemovedChatBoost(FilterExecutor executor, UpdateHandler<ChatBoostRemoved> handler)	Use this method to register new handler for incoming Update.removed_chat_boost update.
void	onShipping(FilterExecutor executor, UpdateHandler<ShippingQuery> handler)	Use this method to register new handler for incoming Update.shipping_query update.
void	processUpdates(List<Update> updates)	Process updates retrieved from long polling or webhook
void	startPolling()	Use this method to run the bot using long polling
void	stop()	Stop the bot

Methods inherited from class java.lang.Object

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

Field Details

context

public BotContext context

Constructor Details

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.message 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.callback_query 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.inline_query 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.poll 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.my_chat_member 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.poll_answer 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.pre_checkout_query 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.chat_member 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.edited_message 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.channel_post 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.edited_channel_post 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.chat_join_request 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.chosen_inline_result 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.shipping_query 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.message_reaction 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.message_reaction_count 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.chat_boost 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.removed_chat_boost 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.business_connection 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.business_message 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.edited_business_message 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.deleted_business_messages 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.purchased_paid_media update.

Parameters:

executor - pre-defined or user-defined filter

handler - a handler to be executed

addHandler

public void addHandler(Object object)

stop

public void stop()

Stop the bot

me

public User me()

processUpdates

public void processUpdates(List<Update> updates)

Process updates retrieved from long polling or webhook

Parameters:

updates - array of Update

startPolling

public void startPolling()

Use this method to run the bot using long polling