Class ExitPlanModeRequest

java.lang.Object
com.github.copilot.sdk.json.ExitPlanModeRequest

public class ExitPlanModeRequest extends Object
Request to exit plan mode and continue with a selected action.

This is sent by the server when the agent wants to exit plan mode and requests user confirmation.

Since:
1.0.8
  • Constructor Details

    • ExitPlanModeRequest

      public ExitPlanModeRequest()
  • Method Details

    • getSummary

      public String getSummary()
      Gets the summary of the plan or proposed next step.
      Returns:
      the summary
    • setSummary

      public ExitPlanModeRequest setSummary(String summary)
      Sets the summary of the plan or proposed next step.
      Parameters:
      summary - the summary
      Returns:
      this instance for method chaining
    • getPlanContent

      public String getPlanContent()
      Gets the full plan content, when available.
      Returns:
      the plan content, or null if not available
    • setPlanContent

      public ExitPlanModeRequest setPlanContent(String planContent)
      Sets the full plan content.
      Parameters:
      planContent - the plan content
      Returns:
      this instance for method chaining
    • getActions

      public List<String> getActions()
      Gets the available actions the user can select.
      Returns:
      the list of actions, or null if not specified
    • setActions

      public ExitPlanModeRequest setActions(List<String> actions)
      Sets the available actions the user can select.
      Parameters:
      actions - the list of actions
      Returns:
      this instance for method chaining
    • getRecommendedAction

      public String getRecommendedAction()
      Gets the action recommended by the runtime.
      Returns:
      the recommended action
    • setRecommendedAction

      public ExitPlanModeRequest setRecommendedAction(String recommendedAction)
      Sets the action recommended by the runtime.
      Parameters:
      recommendedAction - the recommended action
      Returns:
      this instance for method chaining