Package com.tnsai.hooks.events

Record Class OnNotification

java.lang.Object
java.lang.Record
com.tnsai.hooks.events.OnNotification
Record Components:
eventId - ULID-shaped correlation id
timestamp - when the agent issued the notification
context - surrounding hook context
kind - category of notification
message - human-readable text
expectedWait - optional "this will take about N" hint — useful for NotificationKind.LONG_RUNNING
All Implemented Interfaces:
ChatHookEvent, HookEvent
public record OnNotification(String eventId, Instant timestamp, HookContext context, NotificationKind kind, String message, Optional<Duration> expectedWait) extends Record implements ChatHookEvent
Fires when an agent needs user attention (issue #60): a confirmation prompt, a long-running status update, an error the user should see asynchronously, or an idle re-engagement signal. A NotificationRouterHook (follow-up) typically consumes these and routes to the right channel (current chat, Telegram, email, Slack).
Since:
0.5.0 (issue #60)

  • Constructor Details

    • OnNotification

      public OnNotification(String eventId, Instant timestamp, HookContext context, NotificationKind kind, String message, Optional<Duration> expectedWait)
      Creates an instance of a OnNotification record class.
      Parameters:
      eventId - the value for the eventId record component
      timestamp - the value for the timestamp record component
      context - the value for the context record component
      kind - the value for the kind record component
      message - the value for the message record component
      expectedWait - the value for the expectedWait record component

  • Method Details

    • eventType

      public String eventType()
      Description copied from interface: HookEvent
      Short stable string identifier of the event kind, e.g. "PreToolUse". Default implementation derives it from the concrete record's simple class name; concrete records may override if a different naming is desirable.
      Specified by:
      eventType in interface HookEvent

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • eventId

      public String eventId()
      Returns the value of the eventId record component.
      Specified by:
      eventId in interface HookEvent
      Returns:
      the value of the eventId record component

    • timestamp

      public Instant timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface HookEvent
      Returns:
      the value of the timestamp record component

    • context

      public HookContext context()
      Returns the value of the context record component.
      Specified by:
      context in interface HookEvent
      Returns:
      the value of the context record component

    • kind

      public NotificationKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component

    • message

      public String message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • expectedWait

      public Optional<Duration> expectedWait()
      Returns the value of the expectedWait record component.
      Returns:
      the value of the expectedWait record component