Annotation Interface EditedMessageHandler

@Retention(RUNTIME) @Target(METHOD) @Repeatable(EditedMessageHandlers.class) public @interface EditedMessageHandler
Annotation for handling edited message events in a declarative manner. Designed for handling events when any message is edited across various chat types, providing comprehensive filtering options including commands, text content, chat types, regular expressions, message types, conversation states, and custom filters. This annotation enables structured handling of message edits with the same comprehensive filtering capabilities as MessageHandler but specifically for edited messages.

Equivalent with using BotClient.onEditedMessage(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 edited message handler should be active.
    String[]
    commands
    Specifies the bot commands to match in edited messages.
    Class<? extends CustomFilter>
    filter
    Custom filter class for advanced filtering of edited message events.
    int
    priority
    Priority order for handler registration and execution.
    String
    regex
    Regular expression pattern to match against edited message text content.
    String
    state
    Conversation state required for this edited message handler to trigger.
    String[]
    texts
    Specifies exact text content to match in the edited message.
    MessageType[]
    type
    Specifies the message types to match in edited messages.

  • Element Details

    • commands

      String[] commands
      Specifies the bot commands to match in edited messages. Multiple commands are combined using OR logic - the handler will trigger if the edited 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 the edited message. Multiple texts are combined using OR logic - the handler will trigger if the edited 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 edited 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 edited message text content. The handler will trigger if the edited 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 edited messages. Multiple message types are combined using OR logic - the handler will trigger if the edited 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 edited message events. Use this to implement custom logic for determining which message edits should trigger this handler.
      Returns:
      class implementing CustomFilter interface
      Default:
      io.github.natanimn.telebof.filters.DefaultCustomFilter.class

    • state

      String state
      Conversation state required for this edited 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