Package com.github.copilot.sdk.json

Record Class UserPromptSubmittedHookInput

java.lang.Object
java.lang.Record
com.github.copilot.sdk.json.UserPromptSubmittedHookInput
Record Components:
timestamp - the timestamp in milliseconds since epoch when the prompt was submitted
cwd - the current working directory
prompt - the user's prompt text
public record UserPromptSubmittedHookInput(long timestamp, String cwd, String prompt) 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 Summary

    Constructors
    Constructor
    Description
    UserPromptSubmittedHookInput(long timestamp, String cwd, String prompt)
    Creates an instance of a UserPromptSubmittedHookInput record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    cwd()
    Returns the value of the cwd record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    prompt()
    Returns the value of the prompt record component.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • UserPromptSubmittedHookInput

      public UserPromptSubmittedHookInput(long timestamp, String cwd, String prompt)
      Creates an instance of a UserPromptSubmittedHookInput record class.
      Parameters:
      timestamp - the value for the timestamp record component
      cwd - the value for the cwd record component
      prompt - the value for the prompt 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 '=='.
      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.

    • 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