Annotation Interface BusinessMessageHandler

@Retention(RUNTIME) @Target(METHOD) @Repeatable(BusinessMessageHandlers.class) public @interface BusinessMessageHandler
Annotation for handling business message events in a declarative manner. Designed specifically for handling messages within Telegram Business accounts, providing comprehensive filtering options for commands, text content, chat types, regular expressions, message types, conversation states, and custom business logic. This annotation enables structured handling of business communications with the same comprehensive filtering capabilities as MessageHandler but specifically tailored for business account contexts and professional communication needs. Equivalent with using BotClient.onBusinessMessage(FilterExecutor, UpdateHandler)
Since:
1.2.0

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    ChatType[]
    chatType
    Specifies the chat types where this business message handler should be active.
    String[]
    commands
    Specifies the bot commands to match in business messages.
    Class<? extends CustomFilter>
    filter
    Custom filter class for advanced filtering of business message events.
    int
    priority
    Priority order for handler registration and execution.
    String
    regex
    Regular expression pattern to match against business message text content.
    String
    state
    Conversation state required for this business message handler to trigger.
    String[]
    texts
    Specifies exact text content to match in business messages.
    MessageType[]
    type
    Specifies the message types to match in business messages.

  • Element Details

    • commands

      String[] commands
      Specifies the bot commands to match in business messages. Multiple commands are combined using OR logic - the handler will trigger if the business message contains any of the specified commands.
      Returns:
      array of command strings to match
      Default:
      {}

    • texts

      String[] texts
      Specifies exact text content to match in business messages. Multiple texts are combined using OR logic - the handler will trigger if the business message text exactly matches any of the specified strings.
      Returns:
      array of exact text strings to match
      Default:
      {}

    • chatType

      ChatType[] chatType
      Specifies the chat types where this business message handler should be active. Multiple chat types are combined using OR logic - the handler will trigger if the chat type matches any of the specified types.
      Returns:
      array of ChatType enum values to filter by
      Default:
      {}

    • regex

      String regex
      Regular expression pattern to match against business message text content. The handler will trigger if the business message text matches the specified regex pattern.
      Returns:
      regex pattern string for message text matching
      Default:
      ""

    • type

      MessageType[] type
      Specifies the message types to match in business messages. Multiple message types are combined using OR logic - the handler will trigger if the business message type matches any of the specified types.
      Returns:
      array of MessageType enum values to filter by
      Default:
      {}

    • filter

      Class<? extends CustomFilter> filter
      Custom filter class for advanced filtering of business message events. Use this to implement custom logic for determining which business messages should trigger this handler, such as filtering by business account type, customer tiers, service categories, or other business-specific criteria.
      Returns:
      class implementing CustomFilter interface
      Default:
      io.github.natanimn.telebof.filters.DefaultCustomFilter.class

    • state

      String state
      Conversation state required for this business message handler to trigger. The handler will only be invoked if the current conversation state matches the specified state value.
      Returns:
      required conversation state string
      Default:
      ""

    • priority

      int priority
      Priority order for handler registration and execution. Handlers with lower priority numbers are registered and executed before those with higher numbers.
      Returns:
      priority integer value (lower = earlier execution)
      Default:
      0