Module com.github.copilot.java
Package com.github.copilot.rpc

Class PermissionRequestResult

java.lang.Object
com.github.copilot.rpc.PermissionRequestResult
public final class PermissionRequestResult extends Object
Result of a permission request decision.

This object indicates whether a permission request was approved or denied, and may include additional rules for future similar requests.

Common Result Kinds

Since:
1.0.0
See Also:

  • Constructor Details

    • PermissionRequestResult

      public PermissionRequestResult()

  • Method Details

    • approveOnce

      public static PermissionRequestResult approveOnce()
      Creates a result that approves this single request.
      Returns:
      a new approved result
      Since:
      1.3.0

    • reject

      public static PermissionRequestResult reject(String feedback)
      Creates a result that rejects the request, optionally forwarding feedback to the LLM.
      Parameters:
      feedback - optional feedback message, or null
      Returns:
      a new rejected result
      Since:
      1.3.0

    • userNotAvailable

      public static PermissionRequestResult userNotAvailable()
      Creates a result denying the request because no user is available to confirm it.
      Returns:
      a new user-not-available result
      Since:
      1.3.0

    • noResult

      public static PermissionRequestResult noResult()
      Creates a result that declines to respond to this permission request, allowing another connected client to answer instead.
      Returns:
      a new no-result result
      Since:
      1.3.0

    • getKind

      public String getKind()
      Gets the result kind as a string.
      Returns:
      the result kind indicating approval or denial

    • setKind

      public PermissionRequestResult setKind(PermissionRequestResultKind kind)
      Sets the result kind using a PermissionRequestResultKind value.
      Parameters:
      kind - the result kind
      Returns:
      this result for method chaining
      Since:
      1.1.0

    • setKind

      public PermissionRequestResult setKind(String kind)
      Sets the result kind using a raw string value.
      Parameters:
      kind - the result kind string
      Returns:
      this result for method chaining

    • getRules

      public List<Object> getRules()
      Gets the approval rules.
      Returns:
      the list of rules for future similar requests

    • setRules

      public PermissionRequestResult setRules(List<Object> rules)
      Sets approval rules for future similar requests.
      Parameters:
      rules - the list of rules
      Returns:
      this result for method chaining

    • getFeedback

      public String getFeedback()
      Gets optional human-readable feedback to forward to the LLM along with the decision.
      Returns:
      the feedback message, or null
      Since:
      1.3.0

    • setFeedback

      public PermissionRequestResult setFeedback(String feedback)
      Sets optional human-readable feedback to forward to the LLM along with the decision.
      Parameters:
      feedback - the feedback message
      Returns:
      this result for method chaining
      Since:
      1.3.0