Record Class UserPromptSubmittedHookInput

java.lang.Object
java.lang.Record
com.github.copilot.rpc.UserPromptSubmittedHookInput
Record Components:
sessionId - the runtime session ID of the session that triggered the hook
timestamp - the timestamp in milliseconds since epoch when the prompt was submitted
cwd - the current working directory
prompt - the user's prompt text
agentId - optional subagent identity, absent for root hooks and older runtimes
agentType - optional subagent identity, absent for root hooks and older runtimes
parentAgentId - optional subagent identity, absent for root hooks and older runtimes
public record UserPromptSubmittedHookInput(String sessionId, long timestamp, String cwd, String prompt, String agentId, String agentType, String parentAgentId) extends Record
Input for a user-prompt-submitted hook.

This hook is invoked when the user submits a prompt, allowing you to intercept and modify the prompt before it is processed.

Since:
1.0.7

  • Constructor Details

    • UserPromptSubmittedHookInput

      public UserPromptSubmittedHookInput(String sessionId, long timestamp, String cwd, String prompt)

    • UserPromptSubmittedHookInput

      public UserPromptSubmittedHookInput(String sessionId, long timestamp, String cwd, String prompt, String agentId, String agentType, String parentAgentId)
      Creates an instance of a UserPromptSubmittedHookInput record class.
      Parameters:
      sessionId - the value for the sessionId record component
      timestamp - the value for the timestamp record component
      cwd - the value for the cwd record component
      prompt - the value for the prompt record component
      agentId - the value for the agentId record component
      agentType - the value for the agentType record component
      parentAgentId - the value for the parentAgentId record component

  • Method Details

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • sessionId

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

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Returns:
      the value of the timestamp record component

    • cwd

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

    • prompt

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

    • agentId

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

    • agentType

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

    • parentAgentId

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