Skip to content

Handlers

Jump to bottom
Jey edited this page Nov 21, 2024 · 14 revisions

Variety of Handlers

In bot development, particularly in systems involving user interactions, it is crucial to manage and process commands and events efficiently.

These annotations mark functions designed to process specific commands, inputs, or updates and provide metadata such as command keywords, scopes, and guards.

Annotations Overview

CommandHandler

The CommandHandler annotation is used to mark functions that process specific commands. This annotation includes properties that define the command's keywords and scopes.

  • value: Specifies the keywords associated with the command.
  • scope: Determines the context or scope in which the command will be checked.
@CommandHandler(["text"])
suspend fun test(user: User, bot: TelegramBot) {
    //...
}

CommandHandler.CallbackQuery

A specialized version of the CommandHandler annotation designed specifically for handling callback queries. It includes similar properties as CommandHandler, with a focus on callback-related commands.

It's actually the same as just @CommandHandler with a preset UpdateType.CALLBACK_QUERY scope.

  • value: Specifies the keywords associated with the command.
  • autoAnswer: Reply to callbackQuery automatically (call answerCallbackQuery before handling).
@CommandHandler.CallbackQuery(["text"])
suspend fun test(user: User, bot: TelegramBot) {
    //...
}

CommonHandler

The CommonHandler annotation is intended for functions that process commands with lower priority compared to CommandHandler and InputHandler. It is used at the source level and provides a flexible way to define common command handlers.

Be aware, priority works within just @CommonHandler's itself (ie. not affects other handlers).

CommonHandler.Text

This annotation specifies text matching against updates. It includes properties to define the matching text, filtering conditions, priority, and scope.

  • value: The text to match against incoming updates.
  • filter: A class that defines conditions used in the matching process.
  • priority: The priority level of the handler, where 0 is the highest priority.
  • scope: The context or scope in which the text matching will be checked.
@CommonHandler.Text(["text"], filter = isNewUserFilter::class, priority = 10)
suspend fun test(user: User, bot: TelegramBot) {
    //...
}

CommonHandler.Regex

Similar to CommonHandler.Text, this annotation is used for matching updates based on regular expressions. It includes properties for defining the regex pattern, options, filtering conditions, priority, and scope.

  • value: The regex pattern used for matching.
  • options: Regex options that modify the behavior of the regex pattern.
  • filter: A class that defines conditions used in the matching process.
  • priority: The priority level of the handler, where 0 is the highest priority.
  • scope: The context or scope in which the regex matching will be checked.
@CommonHandler.Regex("^\d+$", scope = [UpdateType.EDIT_MESSAGE])
suspend fun test(update: EditedMessageUpdate, user: User, bot: TelegramBot) {
    //...
}

InputHandler

The InputHandler annotation marks functions that process specific input events. It is intended for functions that handle inputs at runtime and includes properties for defining input keywords and scopes.

  • value: Specifies the keywords associated with the input event.
@InputHandler("text")
suspend fun test(update: ProcessedUpdate, user: User, bot: TelegramBot) {
    //...
}

UnprocessedHandler

The UnprocessedHandler annotation is used to mark functions that handle updates not processed by other handlers. It ensures that any unprocessed updates are managed appropriately, with only one processing point possible for this handler type.

@UnprocessedHandler
suspend fun test(update: ProcessedUpdate, user: User, bot: TelegramBot) {
    //...
}

UpdateHandler

The UpdateHandler annotation marks functions that handle specific types of incoming updates. It provides a way to categorize and process different update types systematically.

  • type: Specifies the types of updates the handler function will process.
@UpdateHandler([UpdateType.PRE_CHECKOUT_QUERY])
suspend fun test(update: PreCheckoutQueryUpdate, user: User, bot: TelegramBot) {
    //...
}

Handler Companion Annotations

There are also additional annotations that are optional to the handlers, complementing the optional behavior of the handlers itself.

They can be placed both on functions to which a handler is applied and on classes, in the latter case they will be automatically applied to all handlers in that class, but if there is a need it is possible to have separate behavior for some functions.

I.e. the applying has such a priority, Function > Class, where function have higher priority.

Rate Limiting

In addition, let us also disclose the rate limiting mechanism described in the annotations.

You can set general limits for each user:

// ...
val bot = TelegramBot("BOT_TOKEN") {
    rateLimiter { // general limits
        limits = RateLimits(period = 10000, rate = 5)
    }
}
Handler specific

Limits on certain actions can be defined using the RateLimits annotation, supported @CommandHandler, @CommandHandler.CallbackQuery, @InputHandler, @CommonHandler.

@CommandHandler(["/start"])
@RateLimits(period = 1000L, rate = 1L)
suspend fun start(user: User, bot: TelegramBot) {
    // ...
}

Guard

You can define guards separately to control access to handlers, supported @CommandHandler, @CommandHandler.CallbackQuery, @InputHandler :

@CommandHandler(["text"])
@Guard(isAdminGuard::class)
suspend fun test(user: User, bot: TelegramBot) {
    //...
}

ArgParser

You can define custom argument parser separately to change parameters parsing behaviour for handlers, supported @CommandHandler, @CommandHandler.CallbackQuery, @CommonHandler:

@CommandHandler(["text"])
@ArgParser(SpaceArgParser::class)
suspend fun test(user: User, bot: TelegramBot) {
    //...
}

see also defaultArgParser

Conclusion

These annotations provide robust and flexible tools for handling commands, inputs, and events, while allowing for separate configurations of rate limits and guards, enhancing the overall structure and maintainability of bot development.

See also

Telegram bot Wiki © KtGram

Clone this wiki locally