Package com.github.copilot.sdk.json

Class UserPromptSubmittedHookOutput

java.lang.Object
com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
public class UserPromptSubmittedHookOutput extends Object
Output for a user-prompt-submitted hook.

Allows modifying the user's prompt before processing.

Since:
1.0.7

  • Constructor Details

    • UserPromptSubmittedHookOutput

      public UserPromptSubmittedHookOutput()

  • Method Details

    • getModifiedPrompt

      public String getModifiedPrompt()
      Gets the modified prompt.
      Returns:
      the modified prompt, or null to use the original

    • setModifiedPrompt

      public UserPromptSubmittedHookOutput setModifiedPrompt(String modifiedPrompt)
      Sets a modified version of the user's prompt.
      Parameters:
      modifiedPrompt - the modified prompt to use instead of the original
      Returns:
      this instance for method chaining

    • getAdditionalContext

      public String getAdditionalContext()
      Gets the additional context to add.
      Returns:
      the additional context, or null

    • setAdditionalContext

      public UserPromptSubmittedHookOutput setAdditionalContext(String additionalContext)
      Sets additional context to be added to the prompt.
      Parameters:
      additionalContext - the additional context
      Returns:
      this instance for method chaining

    • getSuppressOutput

      public Boolean getSuppressOutput()
      Gets whether output should be suppressed.
      Returns:
      true to suppress output, or null

    • setSuppressOutput

      public UserPromptSubmittedHookOutput setSuppressOutput(Boolean suppressOutput)
      Sets whether to suppress the output.
      Parameters:
      suppressOutput - true to suppress output
      Returns:
      this instance for method chaining