Class SessionPlanApi

java.lang.Object

com.github.copilot.generated.rpc.SessionPlanApi

@Generated("copilot-sdk-codegen")
public final class SessionPlanApi
extends Object

API methods for the plan namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	delete()	Deletes the session plan file from the workspace.
CompletableFuture<SessionPlanReadResult>	read()	Reads the session plan file from the workspace.
CompletableFuture<SessionPlanReadSqlTodosResult>	readSqlTodos()	Reads todo rows from the session SQL database for plan rendering.
CompletableFuture<SessionPlanReadSqlTodosWithDependenciesResult>	readSqlTodosWithDependencies()	Reads todo rows AND dependency edges from the session SQL database for structured progress UI.
CompletableFuture<Void>	update(SessionPlanUpdateParams params)	Writes new content to the session plan file.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

read

@CopilotExperimental
public CompletableFuture<SessionPlanReadResult> read()

Reads the session plan file from the workspace.

Since:

1.0.0

update

@CopilotExperimental
public CompletableFuture<Void> update(SessionPlanUpdateParams params)

Writes new content to the session plan file.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

delete

@CopilotExperimental
public CompletableFuture<Void> delete()

Deletes the session plan file from the workspace.

Since:

1.0.0

readSqlTodos

@CopilotExperimental
public CompletableFuture<SessionPlanReadSqlTodosResult> readSqlTodos()

Reads todo rows from the session SQL database for plan rendering.

Since:

1.0.0

readSqlTodosWithDependencies

@CopilotExperimental
public CompletableFuture<SessionPlanReadSqlTodosWithDependenciesResult> readSqlTodosWithDependencies()

Reads todo rows AND dependency edges from the session SQL database for structured progress UI. Same defensive behavior as readSqlTodos — returns empty arrays when the database, tables, or columns aren't available. Clients should call this on session start and after every `session.todos_changed` event to refresh structured-UI rendering.

Since:

1.0.0